Tenant Public API
La Tenant Public API est la surface API utilisée au nom d'un tenant.
Elle est commune aux partenaires, clients et intégrateurs. Un partenaire obtient d'abord les credentials du tenant via les Partner APIs ; un client ou intégrateur peut commencer directement ici lorsqu'il dispose déjà de ses credentials.
Swagger / OpenAPI — SANDBOX
➡️ Ouvrir le Swagger de la Tenant Public API — SANDBOX
Ce Swagger regroupe le contrat technique SANDBOX des domaines Onboarding, Directory Service et Flow Service.
Collection Postman
➡️ Télécharger bcs-tenant-public-api
➡️ Ouvrir dans Postman ↗
La collection couvre l'ensemble de la Tenant Public API et reprend la même séparation fonctionnelle que la documentation :
Onboarding and Legal Units;Directory service (AFNOR);Flow service (AFNOR).
Le folder Flow distingue ensuite e-Invoicing (Invoices, Status) et e-Reporting (FRR).
➡️ Voir les ressources Postman
Les pages de cette documentation expliquent les concepts, parcours et recommandations d'intégration. Pour le contrat exact des endpoints, payloads, paramètres, modèles et codes HTTP, le Swagger/OpenAPI SANDBOX fait foi.
Supervision transverse
La disponibilité technique de la Tenant Public API peut être contrôlée via :
GET /v1/healthcheck
Cette route est commune à la Tenant Public API et ne dépend pas d'un domaine métier particulier.
➡️ Supervision de la Tenant Public API
Les trois domaines
1. Onboarding
API spécifique à myBCS / BCSolutions.
Elle permet de créer les unités légales rattachées au tenant et de piloter leur parcours d'onboarding.
➡️ Onboarding
2. Directory Service
API exposée selon les principes et contrats issus des spécifications AFNOR applicables.
Elle permet de rechercher les entreprises, établissements, codes routage et lignes d'annuaire afin de déterminer l'adressage du destinataire.
3. Flow Service
API exposée selon les principes et contrats issus des spécifications AFNOR applicables.
Elle permet de déposer, rechercher et récupérer les flux : factures, cycles de vie CDAR et flux de e-reporting.
➡️ Flow Service
Mode d'interrogation actuel
L'intégration est actuellement initiée par le client API :
- l'onboarding est suivi en interrogeant son état ;
- le Directory Service est consulté à la demande ;
- le Flow Service est interrogé régulièrement pour rechercher les nouvelles factures, les nouveaux statuts CDAR et les évolutions des flux.
La plateforme n'expose actuellement aucun webhook public pour ces notifications. L'ERP ou le SI doit donc mettre en œuvre un polling maîtrisé avec un point de reprise durable.
➡️ Interroger les APIs et mettre en œuvre la synchronisation
Progression recommandée
Le Directory Service est utilisé lorsqu'une recherche d'adressage ou de routage est nécessaire avant l'émission d'une facture. La progression fonctionnelle reste cependant : onboarding de l'entité, détermination du destinataire, puis échange de flux.