les clients | synchro des rendez-vous |
le toiletteur et son logiciel |
URL API | https://www.planningtoiletteur.com/api/ |
Cette documentation intéressera les informaticiens.
L'objectif est de permettre au logiciel du toiletteur de "discuter" avec cette plateforme pour récupérer les rendez-vous. |
Syntaxe | https://www.planningtoiletteur.com/api/<nom_de_la_methode> | |
Méthode | POST | |
Retour | format JSON |
méthode | objectif | |
---|---|---|
token-get | récupération par le logiciel métier d'un token d'identification | Les 2 fonctions pour la synchronisation des rendez-vous |
give-me-news | synchronisation des rendez-vous et des présences/absences des toiletteurs entre la plateforme et le logiciel métier | |
token-test | tester si un token est toujours vivant | Les 3 fonctions complémentaires mais pas indispensables |
user-load | récupérer la fiche d'un utilisateur | |
user-list-load | récupérer la liste des fiches utilisateurs |
token-get | récupération par le logiciel métier d'un token d'identification |
give-me-news | synchronisation des rendez-vous et des présences/absences des toiletteurs entre la plateforme et le logiciel métier |
token-test | tester si un token est toujours vivant |
user-load | récupérer la fiche d'un utilisateur |
user-list-load | récupérer la liste des fiches utilisateurs |
3 paramètres obligatoires pour toutes les fonctions | |||
---|---|---|---|
Paramètre | Valeur | Type | |
api_version |
1 | int |
obligatoire
|
pms_name |
|
str30 |
obligatoire
|
nom du logiciel "métier" du toiletteur | |||
pms_version |
|
str30 |
obligatoire
|
version du logiciel "métier" du toiletteur |
token-get
Cette fonction renvoie un token d'identification. Toutes les autres fonctions auront besoin de ce token. C'est la première fonction à appeler. Un token a une durée de vie. Les autres fonctions retourneront une erreur lorsqu'il faudra le renouveller. |
|||
---|---|---|---|
Paramètre | Valeur | Type | |
login |
|
str70 |
obligatoire
|
Nom d'utilisateur d'un "robot"
Seul un "robot" a le droit de communiquer avec la plateforme de prise de rendez-vous. Commencer par créer un utilisateur de type "robot" dans le paramétrage de l'"Accès toiletteur". |
|||
password |
|
str70 |
obligatoire
|
Mot de passe du robot | |||
retour OK: |
JSON: { "success": true, "token": "A100", "id_etablissement": "A36"}
|
||
retour KO: |
JSON: { "success": false, "error_code": "CODE", "error_message": "MESSAGE" }
|
||
"error_code" possibles : _ERROR_YOU_ARE_NOT_A_ROBOT _ERROR_GENERATOR_TOKEN _ERROR_PARAMETER_UNKNOWN _ERROR_PARAMETER_INCOHERENT _ERROR_CONNEXION_DATABASE _ERROR_MAINTENANCE_EN_COURS _ERROR_CALLING_API _ERROR_EXCEPTION _ERROR_UNKNOWN la signification des codes erreurs se trouve dans le paramètre "error_message" |
give-me-news
"Quoi de neuf docteur ?" Cette fonction est la plus importante de l’API. Elle permet d’échanger les objets à synchroniser entre la plateforme et le logiciel métier. Le logiciel métier (PMS) est toujours à l’initiative. Un système d’accusés de réception permet au PMS d’avoir un retour sur les demandes qu’il a envoyé à la plateforme (WEB). Fonctionnement : A intervalle régulier, le PMS appelle cette fonction « give-me-news » en envoyant 3 listes :
En retour, la plateforme WEB répond en renvoyant deux listes au PMS :
Au préalable, à la mise en place de ce service dans le PMS, il faudra établir les correspondances entre les identifiants des utilisateurs du PMS et ceux de la plateforme. Pour cela, la fonction "user-list" de l’API est parfaite. Elle n'est pas indispensable puisque les correspondances peuvent être réalisées à la main dans le PMS avec les identifiants (id_user) indiqués en haut de cette page. Fréquence d'appels et volume de données : Afin de ne pas surcharger la plateforme, la fréquence d'appels des fonctions de l'API est limitée à 30 secondes minimum. La plateforme rejettera vos appels si vous essayez d'augmenter la fréquence : le code erreur obtenue en retour sera _ERROR_FREQUENCE_FAIR_PLAY. De la même manière, le volume de données envoyé dans chacune des listes de la fonction "give-me-news" est volontairement limitée à 30 objets maximum par liste. Il est peu probable que 30 rendez-vous aient été modifiés dans le PMS ou sur la plateforme en l'espace de 30 secondes... Si vous essayez de dépasser 30 objets, votre appel à cette fonction sera rejetté et vous obtiendrez en retour le code erreur _ERROR_TOO_MUCH_RECORDS_IN_JSON_LIST |
|||
---|---|---|---|
Paramètre | Valeur | Type | |
token |
|
str200 |
obligatoire
|
resa_changed_from_pms |
|
text |
optionnel
|
Si demande de création ou de modification d'un rendez-vous :
|
|||
presences_changed_from_pms |
|
text |
optionnel
|
{
|
|||
ack_from_pms |
|
text |
optionnel
|
{
|
|||
retour OK: |
JSON: { "success": true,
|
||
retour KO: |
JSON: { "success": false, "error_code": "CODE", "error_message": "MESSAGE" }
|
||
error_code possibles : _ERROR_PARAMETER_UNKNOWN _ERROR_PARAMETER_INCOHERENT _ERROR_YOU_ARE_NOT_A_ROBOT _ERROR_GENERATOR_TOKEN _ERROR_MAINTENANCE_EN_COURS _ERROR_TOO_MUCH_RECORDS_IN_JSON_LIST _ERROR_FREQUENCE_FAIR_PLAY _ERROR_CREDITER_LE_COMPTE la signification des codes erreurs se trouve dans le paramètre "error_message" |
token-test
Cette fonction permet de vérifier si un token est toujours vivant. |
|||
---|---|---|---|
Paramètre | Valeur | Type | |
token |
|
str200 |
obligatoire
|
retour OK: |
JSON: { "success": true, "vivant": true/false }
|
||
retour KO: |
JSON: { "success": false, "error_code": "CODE", "error_message": "MESSAGE" }
|
||
"error_code" possibles : _ERROR_YOU_ARE_NOT_A_ROBOT _ERROR_PARAMETER_UNKNOWN _ERROR_PARAMETER_INCOHERENT _ERROR_CONNEXION_DATABASE _ERROR_MAINTENANCE_EN_COURS _ERROR_CALLING_API _ERROR_EXCEPTION _ERROR_UNKNOWN la signification des codes erreurs se trouve dans le paramètre "error_message" |
user-load
Récupération des champs d'un utilisateur. |
|||
---|---|---|---|
Paramètre | Valeur | Type | |
token |
|
str200 |
obligatoire
|
id_user |
|
str36 |
obligatoire
|
retour OK: |
JSON: { "success": true,
|
||
retour KO: |
JSON: { "success": false, "error_code": "CODE", "error_message": "MESSAGE" }
|
||
"error_code" possibles : _ERROR_YOU_ARE_NOT_A_ROBOT _ERROR_PARAMETER_UNKNOWN _ERROR_PARAMETER_INCOHERENT _ERROR_CONNEXION_DATABASE _ERROR_MAINTENANCE_EN_COURS _ERROR_CALLING_API _ERROR_EXCEPTION _ERROR_UNKNOWN la signification des codes erreurs se trouve dans le paramètre "error_message" |
user-list-load
Récupération de tous les utilisateurs. |
|||
---|---|---|---|
Paramètre | Valeur | Type | |
token |
|
str200 |
obligatoire
|
retour OK: |
JSON: { "success": true,
|
||
retour KO: |
JSON: { "success": false, "error_code": "CODE", "error_message": "MESSAGE" }
|
||
"error_code" possibles : _ERROR_YOU_ARE_NOT_A_ROBOT _ERROR_PARAMETER_UNKNOWN _ERROR_PARAMETER_INCOHERENT _ERROR_CONNEXION_DATABASE _ERROR_MAINTENANCE_EN_COURS _ERROR_CALLING_API _ERROR_EXCEPTION _ERROR_UNKNOWN la signification des codes erreurs se trouve dans le paramètre "error_message" |