Architecture et parcours
Familles d'API
Partner APIs
Les Partner APIs orchestrent l'administration initiale du client final opéré par un partenaire.
Elles servent notamment à :
- créer le tenant ;
- lancer son provisioning ;
- obtenir les informations nécessaires à l'accès à la Tenant Public API ;
- générer ou renouveler le secret associé ;
- réinitialiser, si nécessaire, l'accès de l'utilisateur principal au Portail Client.
La création de l'unité légale et le pilotage de son onboarding standard sont réalisés via la Tenant Public API, et non via la Partner API.
Les opérations historiques de création d'unités légales/offices, claim et validation manuelle peuvent exister en SANDBOX pour les partenaires autorisés au mode MANUAL. Elles ne constituent pas le parcours cible de production.
Tenant Public API — Onboarding
Après la création et le provisioning du tenant, l'API Onboarding permet notamment :
- de créer et consulter les unités légales racines ;
- de démarrer ou reprendre un onboarding ;
- de récupérer le lien du parcours utilisateur ;
- de consulter l'état courant ;
- de redémarrer un parcours expiré ;
- de demander sa clôture et sa réconciliation ;
- de consulter l'historique de progression.
Tenant Public API — Directory Service
Le Directory Service est une API de consultation utilisée avant l'émission d'une facture pour identifier ou vérifier le destinataire à partir notamment :
- d'un SIREN ;
- d'un SIRET ;
- d'un code de routage ;
- d'une ligne d'annuaire.
Tenant Public API — Flow Service
Le Flow Service permet de déposer, rechercher et récupérer les flux de facturation ainsi que les flux de cycle de vie associés.
Le statut technique d'intégration d'un flux doit être distingué du statut métier porté par un flux de cycle de vie.
Parcours recommandé
Les endpoints exacts, champs obligatoires, codes de réponse et modèles de données doivent être vérifiés dans les guides dédiés et dans l'OpenAPI de l'environnement utilisé.