Aller au contenu principal

Principes et parcours partenaire

Principes structurants​

Les règles suivantes structurent le contrat d'intégration des Partner APIs.

Identité partenaire déduite du token​

Le partnerId n'est jamais fourni par le partenaire dans les requêtes. Il est résolu à partir du client OAuth authentifié.

Ownership strict​

Un partenaire ne peut lister, créer ou manipuler que ses propres tenants.

Tenant scoping explicite​

Pour les routes tenant-scoped, le paramètre de chemin tenantSlug et le header x-tenant doivent correspondre exactement.

Provisioning canonique​

Le provisioning repose sur le moteur landlord standard. L'API partenaire est une surface d'orchestration et non un workflow parallèle.

Asynchronisme​

Le provisioning et certaines actions d'onboarding déclenchent des traitements asynchrones. La réponse initiale confirme le dispatch et non l'achèvement complet du processus.

Révélation sensible one-time​

Les credentials bootstrap de tenant-public-api ne sont révélés qu'une seule fois et doivent être manipulés comme un secret d'exploitation.

Erreurs normalisées​

Les erreurs métier sont renvoyées au format RFC7807 / Problem Details, avec code métier, correlationId et éventuels détails de validation.

Vue d'ensemble du parcours cible​

Le parcours standard est le suivant :

  1. Obtenir un access token partenaire via OAuth2 client_credentials.
  2. Lister les tenants affiliés.
  3. Créer un tenant.
  4. Lancer le provisioning du tenant.
  5. Récupérer les informations d'accès bootstrap à tenant-public-api.
  6. Générer ou renouveler le clientSecret lorsque le dispositif de stockage sécurisé est prêt.
  7. Réinitialiser si nécessaire le mot de passe de l'utilisateur principal.

Le Directory français exposé par les Partner APIs ne fait pas partie du parcours standard QUAL/PROD. Il est réservé au parcours historique MANUAL en SANDBOX décrit plus bas.

Parcours recommandé​

1. Obtenir un access token OAuth2​

Utiliser le client confidentiel partenaire fourni par BCSolutions.

2. Lister les tenants affiliés​

GET /v1/tenants

3. Créer un tenant partenaire​

POST /v1/tenants

Le champ onboardingMode peut prendre les valeurs :

  • "AUTO" : le tenant suit le parcours d'onboarding ;
  • "MANUAL" : le tenant est créé sans passer par le parcours d'onboarding. Cette valeur est disponible uniquement en SANDBOX lorsque l'option MANUEL est activée sur le compte partenaire.

4. Lancer le provisioning canonique​

POST /v1/tenants/{tenantSlug}/provision

5. Bootstrap de tenant-public-api​

API :

GET /v1/tenants/{tenantSlug}/public-api-access

Cette API permet de récupérer les informations bootstrap de l'accès Tenant Public API, notamment le clientId et l'apiAccessId nécessaires aux opérations suivantes.

6. Générer un nouveau secret​

API :

POST /v1/tenants/{tenantSlug}/public-api-access/{apiAccessId}/rotate

Ne déclenchez cette opération que lorsque le client ou le dispositif de stockage sécurisé est prêt à capturer le nouveau secret.

7. Réinitialiser le mot de passe principal si nécessaire​

API :

POST /v1/tenants/{tenantSlug}/principal-user/reset-password

Cette étape est optionnelle et dépend du parcours opérationnel.

Parcours historique MANUAL en SANDBOX​

Ce parcours est séparé du parcours standard décrit ci-dessus. Il concerne exclusivement les tenants créés avec "onboardingMode": "MANUAL" en SANDBOX. En QUAL et en PROD, la mise en service passe par le workflow d'onboarding de la Tenant Public API.

Rechercher l'entreprise dans le Directory français​

API :

GET /v1/tenants/{tenantSlug}/directory/french?q=<critère>

Cette API SANDBOX permet de vérifier un SIREN, un SIRET ou un nom d'entreprise avant la création des ressources utilisées par le parcours MANUAL.

Les étapes historiques sont ensuite :

  1. rechercher si nécessaire l'entreprise dans le Directory français ;
  2. créer la legal unit de référence ;
  3. créer éventuellement un office ;
  4. démarrer le claim d'une legal unit ou d'un office ;
  5. approuver le KYB manuel lorsque le parcours métier l'autorise ;
  6. consulter l'état d'onboarding.
Restriction

Ces opérations MANUAL ne s'appliquent pas aux tenants en mode AUTO, ni aux environnements QUAL et PROD.

Conseil d'exploitation

Le parcours n'impose pas nécessairement de rechercher le directory avant création. En pratique, cette vérification est fortement recommandée afin d'éviter les erreurs sur les identifiants réglementaires, en particulier avant la création d'un office avec un SIRET.