Intégration client ou intégrateur
➡️ Première intégration ? Démarrer en Sandbox
Un client ou son intégrateur n'utilise pas les Partner APIs pour créer ou administrer son tenant.
Son environnement myBCS et ses accès techniques doivent être disponibles avant le démarrage de l'intégration. Une fois les credentials obtenus, il utilise directement la Tenant Public API.
Swagger / OpenAPI — SANDBOX
➡️ Ouvrir le Swagger de la Tenant Public API — SANDBOX
Le Swagger constitue la référence technique pour les endpoints Onboarding, Directory Service et Flow Service exposés par la Tenant Public API sur la SANDBOX.
Collections Postman — SANDBOX
➡️ Accéder aux collections Onboarding, Directory Service et Flow Service
Ce qui est différent pour un client
Le point d'entrée est différent de celui d'un partenaire :
- le client ne crée pas son tenant via les Partner APIs ;
- il ne gère pas le provisioning partenaire ;
- il commence son intégration à partir de ses accès Tenant Public API ;
- il utilise ensuite le même set documentaire Tenant Public API que les partenaires.
Un partenaire suit donc :
Partner APIs
→ création / provisioning du tenant
→ obtention des accès Tenant Public API
→ Tenant Public API
Un client ou intégrateur suit directement :
tenant et accès disponibles
→ Tenant Public API
Les services disponibles
La Tenant Public API regroupe trois domaines fonctionnels.
Onboarding
Permet de créer une unité légale et de piloter son parcours d'onboarding.
Selon le parcours d'exploitation retenu, certaines opérations peuvent également être réalisées depuis le Portail Client. La présente documentation décrit le mode d'intégration programmatique via API.
➡️ Consulter les API Onboarding
Directory Service
Permet de rechercher et vérifier les données nécessaires à l'adressage d'un destinataire : SIREN, SIRET, code routage et ligne d'annuaire.
➡️ Consulter le Directory Service
Flow Service
Permet de déposer, rechercher et récupérer les factures, ainsi que de suivre les flux associés.
Répartition des responsabilités
| Sujet | BCSolutions / myBCS | Client ou intégrateur |
|---|---|---|
| Tenant | Met à disposition l'environnement client | Utilise le tenant attribué |
| Accès API | Met à disposition le mécanisme d'accès prévu | Protège et utilise ses credentials |
| Onboarding | Expose le service et orchestre le workflow | Pilote le parcours via portail ou API selon son mode d'intégration |
| Directory | Expose le service d'annuaire | Recherche et vérifie l'adressage |
| Flow | Traite et expose les flux et leurs statuts | Dépose, récupère et suit les flux |
Parcours recommandé
- disposer du tenant et de ses accès techniques ;
- obtenir un access token OAuth2 ;
- identifier le contexte d'organisation attendu par les APIs ;
- créer ou retrouver l'unité légale ;
- réaliser et suivre l'onboarding ;
- consulter le Directory Service avant émission lorsque le routage doit être déterminé ou vérifié ;
- déposer, rechercher ou récupérer les flux via le Flow Service ;
- distinguer les statuts techniques des statuts métier de cycle de vie.
➡️ Démarrer avec la Tenant Public API
➡️ Voir le parcours d'intégration
Règles communes
Les règles OAuth2, headers, REST/JSON, erreurs, résilience, observabilité, sécurité, compatibilité et dépréciation sont documentées une seule fois.
➡️ Integration Guidelines
➡️ Cycle de vie et versionnement des API
Les détails contractuels des endpoints, payloads, paramètres et codes de réponse doivent être vérifiés dans le Swagger/OpenAPI SANDBOX.