Aller au contenu principal

Démarrer avec la Tenant Public API

La Tenant Public API est la surface commune utilisée au nom d'un tenant par les partenaires, les clients et les intégrateurs.

La différence porte principalement sur la manière dont le tenant et ses accès sont obtenus avant d'arriver sur cette API.

Selon votre profil​

Partenaire​

Le partenaire commence par les Partner APIs afin de :

  1. créer le tenant ;
  2. lancer son provisioning ;
  3. obtenir les informations d'accès à la Tenant Public API ;
  4. générer ou renouveler le secret associé.

Il poursuit ensuite avec la Tenant Public API.

➡️ Parcours partenaire

Client ou intégrateur​

Le client ou son intégrateur ne passe pas par les Partner APIs.

Son tenant et ses accès doivent être disponibles avant le démarrage de l'intégration. Une fois ces éléments obtenus, il peut utiliser directement la Tenant Public API.

➡️ Parcours client ou intégrateur

Prérequis techniques​

Pour appeler les APIs du tenant, l'intégrateur doit disposer des éléments communiqués pour son environnement, notamment :

  • d'un client_id ;
  • d'un client_secret ;
  • du contexte tenant / organisation attendu par les endpoints concernés ;
  • de l'URL de l'Auth Server et du host API correspondant à l'environnement utilisé.
Protection des secrets

Le client_secret doit être stocké dans un coffre de secrets ou un mécanisme équivalent. Il ne doit pas être placé dans le code source, une URL ou les logs applicatifs.

Parcours recommandé​

  1. Obtenir un access token OAuth2.
  2. Positionner le contexte tenant requis par l'API appelée.
  3. Créer ou retrouver l'unité légale.
  4. Réaliser l'onboarding et suivre son état jusqu'à un état exploitable.
  5. Consulter le Directory Service avant émission lorsque l'adressage du destinataire doit être déterminé ou vérifié.
  6. Déposer, rechercher ou récupérer les flux via le Flow Service.

Portail Client et API​

Certaines opérations peuvent être proposées depuis le Portail Client en complément des APIs.

Pour une intégration automatisée ERP / SI, les pages de cette documentation décrivent le parcours programmatique utilisant la Tenant Public API.

Aller plus loin​

➡️ Authentification et contexte tenant
➡️ Parcours d'intégration
➡️ Onboarding
➡️ Directory Service
➡️ Flow Service