1. Introduction
Listoordv proposÉ aussi une API publique compatible à toute type d’application que ce soit web, desktop ou mobile.
Pour utiliser l'API , vous devez vous inscrire en tant que développeur et recuperer votre token qui s’en servira comme clé de votre application.
La documentation des fonctionnalités présente des informations plus détaillées sur nos points de terminaison définis.
Si vous avez des questions, nous sommes disponibles à support@listordv.com pour vous aider.
2.1. Récupérer votre jeton d'authentification
Prêt à intégrer listordv dans votre application ?, Connectez-vous à votre compte Listordv API developper http://api.listoordv.com/user/api/login , Et cliquer sur Generate token si vous n’avez pas un token généré automatiquement.
Voilà, vous avez vos token d'acces.
2.1. Teter le token d'accès
Vous pouvez utiliser curl pour tester vos token
curl -v --header "x-auth-api: Bearer <your_token>" http://api.listoordv.com/api/helloworld
Resultat :
{
"success": true,
"message": "Welcome to listoordv API"
}
3. Compte utilisateur
3.1 Verifier un email d'utilisateur
Vous pouvez tout simplement verifier via notre API si un email existe dejà sur pour un compte listoordv.
Pour cela, vous pouvez utiliser l'endpoint /api/user/email_check
Exemple :
curl --header "x-auth-api: Bearer <your_token>" --data "email=listoordv@mail.com" http://api.listoordv.com/api/user/email_check
3.2 Vérifier les identifiants de l'utilisateur
curl
--header "x-auth-api: Bearer <your_token>"
--data "{
'user_email' : 'listoordv@mail.com'
'password' : 'user_password'
}"
http://api.listoordv.com/api/user/login_check
3.3 Creer un utilisateur
curl
-H "x-auth-api: Bearer <your_token>"
-H "Content-Type: application/json"
--data "{
'user_name' : 'Jhon',
'email' : 'jhondoe@mail.com',
'password' : '4v3ry5tr0ngp455word',
'timezone' : 'GM+3'
}"
http://api.listoordv.com/api/user
Un profil sera attribué automatique à un nouveau utilisateur avec le nom d'utilisateur comme un lien pardefaut:
Exemple resultat :
{
"success": true,
"message": "User enregistrer avec succes et en attente d'activation",
"data": {
"id": 9,
"username": "utilisatuer avec timezone",
"email": "newuser@mail.com",
"profil": {
"id": 2,
"link": "newuser",
"date_created": "2020-07-25T20:03:47+02:00",
"timezone": "GMT+3"
}
}
}
3.5 . Relance d'un mail d'activation
Endpoint : http://api.listoordv.com//api/user/activation , Method : GET , Paramettre : ["email"]
exemple :
curl -v --header "x-auth-api: Bearer <your_token>" http://api.listoordv.com/api/user/activation?email=user@mail.com
3.6 . Activation de compte d'utilisateur
curl
-H "x-auth-api: Bearer <your_token>"
-H "Content-Type: application/json"
--data "{
'token' : 'token d'activation envoyé par email aux utilisateur'
}"
http://api.listoordv.com/api/user/activation
3.7 . Modifier un profil d'utilisateur
curl
-H "x-auth-api: Bearer <your_token>"
-H "Content-Type: application/json"
-X PUT
--data "{
'user_id' : '9',
'profil_link' : 'profil_link',
'country' : 'country',
'timezone' : 'GMT+3',
'description' : 'timezone'
}"
http://api.listoordv.com/api/profil
4. Les evenements
4.1. Poster un evenement privé
Endpoint : http://api.listoordv.com/api/event , Method : POST , Paramettre : ["user_id" "title" "link" "description" "location" "color" "max_invite" "max_invite"]
curl
-H "x-auth-api: Bearer <your_token>"
-H "Content-Type: application/json"
--data "{
'user_id' : '9'
'title' : 'Evenement teste'
'link' : '/evenement-teste'
'description' :'Ceci est un evenement de teste',
'location' :'web'
'color' :'red',
'timezone' :'GMT+3'
}"
http://api.listoordv.com/api/event
4.2. Poster un evenement groupe
Endpoint : http://api.listoordv.com/api/event/group , Method : POST , Paramettre : ["user_id" "title" "link" "description" "location" "color" "max_invite" "max_invite" "max_invite"]
curl
-H "x-auth-api: Bearer <your_token>"
-H "Content-Type: application/json"
--data "{
'user_id' : '9'
'title' : 'Evenement teste'
'link' : '/evenement-teste'
'description' :'Ceci est un evenement de teste',
'location' :'web'
'color' :'red',
'timezone' :'GMT+3',
'max_invite' :'3'
}"
http://api.listoordv.com/api/event/group
4.3. Modifier un evenement groupe
Endpoint : http://api.listoordv.com/api/event/group , Method : PUT , Paramettre : ["user_id" "title" "link" "description" "location" "color" "timezone" "max_invite"]
curl
-H "x-auth-api: Bearer <your_token>"
-H "Content-Type: application/json"
-X PUT
--data "{
'user_id' : '9' ,
'event_id' : '5' ,
'title' : 'Evenement teste' ,
'link' : '/evenement-teste'
'description' :'Ceci est un evenement de teste',
'location' :'web' ,
'color' :'red',
'timezone' :'GMT+3',
'max_invite' :'8'
}"
http://api.listoordv.com/api/event
Remarque : max_invite n'est pas exiger si l'evenement est de type privée
4.4. Recuperer la liste des evenements d'un utilisateur
Endpoint : http://api.listoordv.com/api/events , Method : GET , Paramettre : ["user_id" "user_email" "user_link" ] NB : Vous ne choisissez qu'un seul paramettre parmis les 3 proposé
Exemple
curl -v --header "x-auth-api: Bearer <your_token>" http://api.listoordv.com/api/events?user_id=9
ou
curl -v --header "x-auth-api: Bearer <your_token>" http://api.listoordv.com/api/events?user_email=jhondoe@mail.com
ou
curl -v --header "x-auth-api: Bearer <your_token>" http://api.listoordv.com/api/events?user_link=jhonlink
5. Disponibilité
5.1 Ajouter une disponiblité
Endpoint : http://api.listoordv.com//api/availability , Method : POST , Paramettre : ["event_id" "user_id" "availabilities" "duration"] , Remarque : availabilities est un tableau de plage date ()
curl
-H "x-auth-api: Bearer <your_token>"
-H "Content-Type: application/json"
--data "{
'user_id' : '9',
'event_id' : '5',
'availabilities' : array()
'duration' : 60'
}"
http://api.listoordv.com//api/availability
5.2 Modifier une disponiblité
Endpoint : http://api.listoordv.com//api/availability , Method : PUT , Paramettre : ["event_id" "user_id" "availabilities" "duration"]
curl
-H "x-auth-api: Bearer <your_token>"
-H "Content-Type: application/json"
-X PUT
--data "{
'availability_id' : '9',
'availabilities' : array()
'duration' : 60'
}"
http://api.listoordv.com//api/availability
5.3 Recuperer un disponibilité
Endpoint : http://api.listoordv.com//api/availability , Method : GET , Paramettre : ["event_id" "event_link" "user_email" "user_link"]
Exemple :
curl -v --header "x-auth-api: Bearer <your_token>" http://api.listoordv.com/api/availability?user_email=user@mail.com&event_link=event-link
NB : event_link est obligatoire, parcontre vous avez un choix entre user_email ou user_link
5.3 Supprimer une disponiblité
Endpoint : http://api.listoordv.com//api/availability , Method : DELETE , Paramettre : ["event_id" "availability_id"]
curl
-H "x-auth-api: Bearer <your_token>"
-H "Content-Type: application/json"
-X DELETE
--data "{
'availability_id' : '9',
'user_id' : '19'
}"
http://api.listoordv.com//api/availability
6. Abonné
L'endpoint abonnée regroupe tout les utilisateur qui s'inscrit sur un evenement.
6.1. Ajouter un abonné
Endpoint : http://api.listoordv.com/api/event/subscriber , Method : POST , Paramettre : [ "event_id" "name" "email" "phone" "note" "timezone" "date" "hour" "hour_end" ]
Exemple :
curl
-H "x-auth-api: Bearer <your_token>"
-H "Content-Type: application/json"
--data "{
'event_id' : '9',
'name' : 'Janne',
'email' : 'janne@mail.com'
'phone' : '+26138740000'
'note' : 'Consultation medical'
'timezone' : 'Europe/Warsaw'
'date' : '07/09/2020'
'hour' : '13:30'
'hour_end' : '14:30'
}"
http://api.listoordv.com/api/event/subscriber
6.1. Recuperer des abonnées a une evenement
Endpoint : http://api.listoordv.com/api/subscriber , Method : GET , Paramettre : [ "event_id" "date" ]
Exemple :
curl -v --header "x-auth-api: Bearer <your_token>" http://api.listoordv.com/api/subscriber?event_id=7&date=Y-m-d
7.1 Recuperer la liste des evement courant d'un utilisateur
http://api.listoordv.com/api/event_current , Method : GET , Paramettre : ["user_id" or "user_email"]
Exemple :
curl -v --header "x-auth-api: Bearer <your_token>" http://api.listoordv.com/api/event_current?user_email=user@mail.com
7.2 Recuperer la liste des evement à venir
http://api.listoordv.com/api/event_upcomming , Method : GET , Paramettre : ["user_id" or "user_email"]
Exemple :
curl -v --header "x-auth-api: Bearer <your_token>" http://api.listoordv.com/api/event_upcomming?user_id=9