Aller au contenu principal

API Partenaires

Le Guide d'utilisation des API Partenaires s'adresse aux partenaires techniques de BCSolutions — ERP, solutions comptables, intégrateurs ou opérateurs métier — qui intègrent la plateforme SaaS eas'Invoice PA au travers des Partner APIs.

Les Partner APIs sont des APIs serveur-à-serveur destinées à l'orchestration des opérations d'initialisation et d'onboarding d'un client opéré par un partenaire. Chaque partenaire dispose de son propre client OAuth2 confidentiel et agit uniquement sur les tenants qui lui sont affiliés.

Swagger / OpenAPI — SANDBOX​

➡️ Ouvrir le Swagger des Partner APIs — SANDBOX

Le Swagger décrit le contrat technique disponible sur la SANDBOX : routes, paramètres, payloads, modèles de réponse, sécurité et codes HTTP.

Collection Postman — SANDBOX​

➡️ Télécharger bcs-partner-api
➡️ Ouvrir la collection dans Postman ↗

La collection permet notamment de tester l'authentification OAuth2, la création et le provisioning des tenants ainsi que la récupération des accès Tenant Public API.

Commencer​

Référence fonctionnelle​

Exploitation​

Périmètre couvert​

Cette documentation couvre notamment :

  • l'authentification par client_credentials ;
  • la liste et la création de tenants partenaires ;
  • le déclenchement du provisioning canonique asynchrone ;
  • en SANDBOX uniquement, la recherche d'une entreprise française dans le Directory du parcours MANUAL ;
  • la création de legal units et d'offices dans le parcours MANUAL SANDBOX ;
  • le démarrage du claim / onboarding depuis une legal unit ou un office dans ce même parcours ;
  • l'approbation d'un KYB manuel lorsque le workflow le prévoit ;
  • la consultation de l'état d'onboarding d'une legal unit ;
  • la consultation du clientId du tenant ;
  • la génération du clientSecret du tenant ;
  • la réinitialisation du mot de passe de l'utilisateur principal du tenant.
Disponibilité selon l'environnement

Sur la SANDBOX, certains endpoints permettent au partenaire de créer directement les éléments d'annuaire d'un client puis de déclencher un claim, valider le KYB manuel et consulter l'état du claim à des fins de test.

Sur la QUAL et la PROD, ce parcours historique n'est pas disponible. Le client doit utiliser les APIs d'onboarding afin de suivre le workflow d'onboarding jusqu'à la signature du mandat de PA avec BCSolutions.

Hors périmètre

Les Partner APIs ne constituent pas les APIs métier de dépôt de flux, de consultation annuaire au nom du tenant, ni un mécanisme de mise à jour directe de l'annuaire réglementaire. Elles exposent une surface d'orchestration qui réutilise les moteurs canoniques de la plateforme.

Référence contractuelle — SANDBOX

Cette documentation est publiée pour la SANDBOX. En cas d'écart entre cette documentation et le contrat exposé par le Swagger SANDBOX, le Swagger fait foi pour le contrat technique.

➡️ Swagger Partner APIs — SANDBOX