Introduction
Environnements
Section titled “Environnements”B2Brouter propose trois environnements. Consultez Environnements pour une comparaison complète.
| Environnement | Base URL | Quand l’utiliser |
|---|---|---|
| Sandbox | https://api.b2brouter.net (préfixe de clé test_) | Développement quotidien, validation de payloads, onboarding |
| Staging | https://api-staging.b2brouter.net | Grandes intégrations, tests de bout en bout larges, environnements QA des autorités |
| Production | https://api.b2brouter.net | Trafic réel |
Commencez par le Sandbox. C’est l’environnement recommandé pour le développement initial et les tests quotidiens. Utilisez staging uniquement pour les intégrations à grande échelle ou les tests de bout en bout étendus nécessitant une configuration complète d’environnement.
Premières étapes
Section titled “Premières étapes”Enregistrez-vous et configurez votre compte
Section titled “Enregistrez-vous et configurez votre compte”Pour commencer à utiliser l’API B2Brouter, inscrivez-vous sur app.b2brouter.net/en/register. Des instructions détaillées de configuration sont disponibles ici.
Une fois inscrit, connectez-vous à B2Brouter et configurez votre compte avec une offre Basic. Vous trouverez des instructions détaillées ici.
Obtenir une clé API sandbox
Section titled “Obtenir une clé API sandbox”Ouvrez la section Developers et créez un sandbox. Votre clé API sandbox commence par test_ et route automatiquement toutes les requêtes vers l’environnement sandbox. Aucune URL distincte n’est nécessaire. Consultez Sandbox pour les instructions complètes de configuration.
Activation de l’environnement staging
Section titled “Activation de l’environnement staging”Si vous avez besoin de l’environnement staging (grandes intégrations, tests de bout en bout larges), inscrivez-vous sur app-staging.b2brouter.net/en/register. Les comptes staging démarrent avec des permissions limitées : soumettez un ticket de support pour demander les accès nécessaires. Notre équipe vous les accordera.
Utilisation de l’API REST
Section titled “Utilisation de l’API REST”Pour accéder à l’API B2Brouter, suivez ces étapes :
- Accédez à votre compte.
- Dans votre compte, cliquez sur l’onglet Developers.
- Cliquez sur la clé API pour la copier dans le presse-papiers.
- Pour trouver les identifiants des comptes, cliquez sur View IDs for each account ou sur l’icône Edit group à côté du nom de votre groupe.
- Accédez à la référence API.
Remarque :
Les clés API sont spécifiques à chaque environnement. Les clés sandbox (préfixe test_) ne fonctionnent qu’en sandbox ; les clés de production uniquement en production ; les clés staging uniquement en staging. Obtenez chaque clé en vous connectant à l’environnement correspondant.
Par défaut, la référence API est documentée avec l’environnement staging. Pour passer à sandbox ou à production, ouvrez le menu déroulant Base URL.
Authentification
Section titled “Authentification”Les identifiants doivent être fournis dans les en-têtes de la requête, sous le nom X-B2B-API-Key.
Version de l’API
Section titled “Version de l’API”Dans B2Brouter, chaque groupe possède une version d’API par défaut. Vous pouvez la vérifier dans l’onglet Developers, sous API Keys. Vous pouvez spécifier manuellement la version d’API dans les en-têtes de la requête, sous le nom X-B2B-API-Version. Si aucune version n’est spécifiée, B2Brouter utilisera la version par défaut du groupe.
Formats de réponse
Section titled “Formats de réponse”B2Brouter fournit les réponses uniquement au format JSON.
Identifiants de compte
Section titled “Identifiants de compte”Utilisez l’endpoint List Accounts.
curl --request GET \ --url https://api-staging.b2brouter.net/accounts \ --header 'X-B2B-API-Key: {YOUR_API_KEY}' \ --header 'X-B2B-API-Version: {YOUR_API_VERSION}' \ --header 'accept: application/json'Dans cette réponse, prêtez attention aux informations du champ identifier. Vous devez utiliser cet identifiant lorsque vous souhaitez interagir avec le compte via l’API.
Remarque : Vous pouvez également trouver les IDs des comptes dans l’onglet Developers en cliquant sur l’icône Edit group à côté du nom de votre groupe. La liste des comptes et de leurs IDs s’affichera.
Limitation de débit de l’API
Section titled “Limitation de débit de l’API”Pour garantir des performances optimales et un usage équitable, l’API B2Brouter applique des limites de débit aux requêtes entrantes :
Limites :
- Production : 1 000 requêtes par minute
- Sandbox / Staging : 600 requêtes par minute
Limite dépassée : Lorsque vous dépassez la limite, l’API renvoie :
- Code HTTP
429 Too Many Requests
Bonnes pratiques :
- Implémentez un backoff exponentiel lorsque vous recevez des réponses 429
- Mettez les réponses en cache lorsque c’est possible afin de réduire les appels API
- Utilisez des webhooks plutôt que du polling pour les mises à jour en temps réel
SDKs et bibliothèques client
Section titled “SDKs et bibliothèques client”Vous pouvez vous intégrer à l’API directement via HTTP ou en utilisant un SDK officiel. Le premier SDK officiel est le SDK PHP :
Il fournit des méthodes pour la gestion complète des factures, le téléchargement de documents multi-format, les opérations complètes sur les déclarations fiscales (y compris Verifactu), les utilitaires de pagination et la gestion des erreurs. D’autres SDKs pour d’autres langages de programmation seront ajoutés au fil du temps.
Télécharger la référence OpenAPI
Section titled “Télécharger la référence OpenAPI”Vous pouvez télécharger la référence complète de l’API REST au format OpenAPI (YAML) depuis les liens suivants :