Aller au contenu principal

API Onboarding

Ressources API​

➡️ Swagger Tenant Public API
➡️ Télécharger bcs-tenant-public-api
➡️ Ouvrir dans Postman ↗

Dans Postman, utilisez le folder Onboarding and Legal Units. Ce folder regroupe les opérations sur les unités légales et le pilotage de l'onboarding. Les liens Swagger et Postman ci-dessus permettent de tester le contrat actuellement publié en SANDBOX.

Workflow standard d'onboarding

La présente section décrit le workflow normal d'onboarding, utilisé pour la mise en service en QUAL et en PROD, ainsi que pour les parcours automatiques correspondants. Elle ne décrit pas le parcours historique MANUAL des Partner APIs, réservé à la SANDBOX.

Les API d'onboarding sont exposées par la Tenant Public API. Elles permettent de :

  • créer et consulter les unités légales racines rattachées au tenant ;
  • configurer les informations nécessaires à leur traitement, notamment la direction opérateur et le régime de TVA ;
  • démarrer puis suivre leur parcours d'onboarding ;
  • redémarrer un onboarding expiré ;
  • annuler un onboarding automatique encore en cours.

Cette API est spécifique à myBCS / BCSolutions : elle ne correspond pas à une API AFNOR.

Le suivi d'une opération asynchrone repose actuellement sur le polling de l'état de l'unité légale. Aucun webhook public d'onboarding n'est exposé.

➡️ Mode d'interrogation et polling Onboarding

Parcours d'intégration​

La création de l'unité légale et le démarrage de l'onboarding sont deux opérations distinctes. Le legalUnitId retourné lors de la création devient l'identifiant canonique utilisé par toutes les routes suivantes.

Routes principales​

Unités légales​

GET   /v1/onboarding/legal-units
POST  /v1/onboarding/legal-units
GET   /v1/onboarding/legal-units/{legalUnitId}
PATCH /v1/onboarding/legal-units/{legalUnitId}/vat-regime

Pilotage de l'onboarding​

POST /v1/onboarding/legal-units/{legalUnitId}/start
GET  /v1/onboarding/legal-units/{legalUnitId}/state
GET  /v1/onboarding/legal-units/{legalUnitId}/history
POST /v1/onboarding/legal-units/{legalUnitId}/restart
POST /v1/onboarding/legal-units/{legalUnitId}/cancel
Pas d'opération close

L'API publiée ne prévoit plus de route POST .../close. La fin normale d'un parcours est reflétée par son état, notamment COMPLETED. Pour un onboarding automatique en cours, l'opération d'annulation exposée est /cancel.

Aller plus loin​

➡️ Concepts Onboarding
➡️ Créer et gérer les unités légales
➡️ Piloter l'onboarding
➡️ État et historique