Collections Postman — SANDBOX

BCSolutions fournit deux collections Postman pour démarrer les tests sur les APIs exposées dans l'environnement SANDBOX :

• bcs-partner-api pour les Partner APIs ;
• bcs-tenant-public-api pour l'ensemble de la Tenant Public API.

Swagger et Postman sont complémentaires

Les collections Postman sont des exemples d'utilisation et facilitent les tests. Le contrat technique de référence reste le Swagger/OpenAPI SANDBOX de l'API concernée.

Les versions des contrats métier, notamment AFNOR, sont documentées dans les pages API et dans le Swagger. Elles ne sont volontairement pas portées dans le nom des collections Postman afin de simplifier leur maintenance.

Comment utiliser une collection

Deux méthodes sont proposées :

1. Télécharger le fichier .postman_collection.json : dans Postman, utilisez ensuite Import > Files ;
2. Ouvrir dans Postman : utilisez le lien de partage de la collection.

Collections disponibles

API	Collection	Swagger
Partner APIs	Télécharger bcs-partner-api · Ouvrir dans Postman ↗	Swagger Partner APIs
Tenant Public API	Télécharger bcs-tenant-public-api · Ouvrir dans Postman ↗	Swagger Tenant Public API

Organisation de bcs-partner-api

La collection partenaire regroupe les blocs nécessaires au parcours partenaire :

• Authentication ;
• Supervision ;
• Tenants ;
• Directory ;
• Legal Unit (Sandbox only - manual onboarding).

Elle permet notamment de créer et provisionner un tenant, récupérer ses accès et exécuter les parcours spécifiques disponibles côté Partner APIs.

Organisation de bcs-tenant-public-api

Une seule collection couvre désormais toute la Tenant Public API, conformément au Swagger unique.

Elle est organisée en folders fonctionnels :

• Authentication ;
• Supervisor ;
• Onboarding and Legal Units ;
• Directory service (AFNOR) ;
• Flow service (AFNOR).

Dans Flow service (AFNOR), les exemples sont eux-mêmes séparés fonctionnellement :

• e-Invoicing - Invoices ;
• e-Invoicing - Status ;
• e-Reporting - FRR.

Cette organisation permet de conserver des blocs d'API clairement séparés sans maintenir plusieurs collections pour une même Tenant Public API.

Utilisation

1. téléchargez la collection correspondant à votre surface API ;
2. configurez les variables nécessaires à votre environnement ;
3. obtenez un token OAuth2 avec le grant client_credentials ;
4. ouvrez le folder correspondant au parcours à tester ;
5. vérifiez le contrat exact dans le Swagger SANDBOX en cas de doute.

Variables référencées

bcs-partner-api

La collection référence notamment :

access_token, apiAccessId, client_id, client_secret, content_type, legalUnitId, name, oauth_token_url, officeId, organizationName, partner_base_url, principalUserEmail, principalUserFirstName, principalUserLastName, tenantSlug, tenant_public_api_url.

bcs-tenant-public-api

La collection référence notamment :

access_token, client_id, client_secret, flow_id, legalUnitId, oauth_token_url, siren, siret, tenantSlug, tenant_public_api_url.

Secrets

Ne publiez jamais de client_secret ou d'access_token dans un export Postman. Utilisez des variables d'environnement ou de collection adaptées à vos pratiques de sécurité.

Parcours conseillé

Pour un client ou intégrateur disposant déjà de ses credentials Tenant Public API, utilisez directement bcs-tenant-public-api.