Recette et mise en production de l'API partenaires
Obtenir une application de recette, tester sur l'organisation de test de la préproduction, puis passer en production : ce qu'il faut préparer, ce que Treats vérifie, comment une clinique vous connecte.
Recette et mise en production
Deux environnements
| Recette | Production | |
|---|---|---|
| Adresse | https://preprod.treats.vet/api/partner/v1 | https://app.treats.vet/api/partner/v1 |
| Application | SANDBOX | LIVE |
| Organisations | une organisation de test, aux données fictives | les cliniques qui vous autorisent |
| Emails et SMS aux clients | jamais envoyés | envoyés selon les réglages de la clinique |
Les identifiants de recette ne fonctionnent pas en production, et inversement.
1. Demander une application de recette
Écrivez à partenaires@treats.vet avec :
- le nom de votre service, tel que les cliniques le verront dans leur logiciel ;
- votre métier (prise de rendez-vous, laboratoire, imagerie, comptabilité…) et les droits dont il a besoin. Demandez le minimum : une clinique accorde plus facilement un accès étroit ;
- l’adresse
https://de votre serveur de notifications, si vous en voulez ; - un contact technique.
Treats crée l’application, la connecte à une organisation de test et vous remet l’identifiant, le secret (une seule fois) et l’identifiant de l’organisation. Suivez ensuite le démarrage rapide.
2. Tester
Votre recette doit au moins couvrir :
- le jeton : demande, réutilisation pendant une heure, nouvelle demande à l’expiration, et la réaction de votre service à
unauthorized_client(organisation déconnectée) ; - les écritures avec
Idempotency-Key, et le renvoi d’un appel après une coupure réseau ; - les refus métier de votre parcours (créneau pris, client introuvable, champ invalide) et l’affichage du
messageà votre utilisateur ; - la synchronisation : premier parcours, reprise avec recouvrement, dédoublonnage (voir Synchronisation) ;
- les notifications : vérification de la signature, réponse rapide, relances, rejeu (voir Notifications) ;
- le quota : votre client attend
Retry-Aftersur un429.
Demandez une organisation de test à plusieurs sites si vos clientes sont des groupes : testez alors l’écriture avec site_id, et ce que vous voyez quand l’autorisation ne couvre qu’un site.
3. Passer en production
Quand la recette est concluante, Treats crée votre application de production, avec les mêmes droits maximum. Avant cela, nous relisons avec vous :
- les droits demandés, et pourquoi chacun ;
- ce que votre service écrit dans le dossier des cliniques, et sous quel nom ;
- la conservation des identifiants (le secret reste sur votre serveur) ;
- votre adresse de notifications en production.
4. Être connecté par une clinique
Chaque organisation cliente autorise votre application, en choisissant ses sites et ses droits. L’autorisation est donnée par un administrateur de l’organisation, avec une confirmation de sa double authentification. L’équipe Treats accompagne la clinique lors de la première mise en service.
Dès l’autorisation donnée, votre serveur peut demander un jeton pour cette organisation. Communiquez à la clinique le nom exact de votre application et les droits à cocher : elle ne peut pas accorder plus que ce que Treats a ouvert.
La clinique peut retirer l’autorisation à tout moment. Votre service doit alors arrêter ses appels pour cette organisation et le dire à son utilisateur.