Introducció
Entorns
Section titled “Entorns”B2Brouter té tres entorns — consulteu Entorns per a una comparació completa.
| Entorn | URL base | Quan usar-lo |
|---|---|---|
| Sandbox | https://api.b2brouter.net (prefix de clau test_) | Desenvolupament diari, validació de payloads, incorporació |
| Staging | https://api-staging.b2brouter.net | Integracions grans, proves d’extrem a extrem àmplies, entorns QA d’autoritats |
| Producció | https://api.b2brouter.net | Tràfic en viu |
Comenceu amb Sandbox. És l’entorn recomanat per al desenvolupament inicial i les proves diàries. Useu staging únicament per a integracions a gran escala o proves d’extrem a extrem àmplies que requereixin una configuració completa de l’entorn.
Primers passos
Section titled “Primers passos”Registreu-vos i configureu el vostre compte
Section titled “Registreu-vos i configureu el vostre compte”Per començar a usar l’API de B2Brouter, registreu-vos a app.b2brouter.net/en/register. Les instruccions detallades de configuració estan disponibles aquí.
Un cop registrats, inicieu sessió a B2Brouter i configureu el vostre compte amb un pla Basic. Podeu trobar instruccions detallades aquí.
Obtenir una clau d’API de sandbox
Section titled “Obtenir una clau d’API de sandbox”Obriu la secció Developers i creeu un sandbox. La vostra clau d’API de sandbox comença amb test_ i encamina totes les peticions a l’entorn sandbox automàticament — no cal cap URL separada. Consulteu Sandbox per a les instruccions completes de configuració.
Activació de l’entorn Staging
Section titled “Activació de l’entorn Staging”Si necessiteu l’entorn staging (integracions grans, proves d’extrem a extrem àmplies), registreu-vos a app-staging.b2brouter.net/en/register. Els comptes de staging comencen amb permisos limitats — envieu un tiquet de suport per sol·licitar l’accés necessari. El nostre equip us el concedirà.
Usar l’API REST
Section titled “Usar l’API REST”Per accedir a l’API de B2Brouter, seguiu aquests passos:
- Accediu al vostre compte.
- Dins del vostre compte, feu clic a la pestanya Developers.
- Feu clic a la clau d’API per copiar-la al porta-retalls.
- Per trobar els IDs dels comptes, feu clic a Veure IDs per a cada compte o feu clic a la icona Editar grup al costat del nom del vostre grup.
- Accediu a la Referència de l’API.
Nota:
Les claus d’API són específiques per a cada entorn. Les claus de sandbox (prefix test_) només funcionen al sandbox; les claus de producció només funcionen a producció; les claus de staging només funcionen a staging. Obteniu cada clau iniciant sessió a l’entorn corresponent.
Per defecte, la Referència de l’API està documentada amb l’entorn staging. Per canviar a sandbox o producció, obriu el desplegable URL base.
Autenticació
Section titled “Autenticació”Les credencials s’han de proporcionar a les capçaleres de la petició, amb el nom X-B2B-API-Key.
Versió de l’API
Section titled “Versió de l’API”A B2Brouter, cada grup té una Versió de l’API per defecte. Podeu comprovar-la a la pestanya Developers, sota Claus d’API. Podeu especificar manualment la Versió de l’API a les capçaleres de la petició, amb el nom X-B2B-API-Version. Si no s’especifica cap versió, B2Brouter usarà la versió per defecte del grup.
Formats de resposta
Section titled “Formats de resposta”B2Brouter proporciona la resposta únicament en format JSON.
Identificadors de compte
Section titled “Identificadors de compte”Useu l’endpoint Llistar comptes
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'En aquesta resposta, pareu atenció a la informació del camp identifier. Heu d’usar aquest ID quan vulgueu interactuar amb el compte a través de l’API.
Nota: També podeu trobar els IDs dels comptes a la pestanya Developers fent clic a la icona Editar grup al costat del nom del vostre grup. Es mostrarà la llista de comptes i els seus IDs.
Limitació de velocitat de l’API
Section titled “Limitació de velocitat de l’API”Per garantir un rendiment òptim i un ús just, l’API de B2Brouter aplica límits de velocitat a les peticions entrants:
Límits de velocitat:
- Producció: 1.000 peticions per minut
- Sandbox / Staging: 600 peticions per minut
Límit de velocitat superat: Quan supereu el límit de velocitat, l’API retorna:
- Codi d’estat HTTP
429 Too Many Requests
Bones pràctiques:
- Implementeu exponential backoff quan rebeu respostes 429
- Emmagatzemeu respostes a la memòria cau quan sigui possible per reduir les crides a l’API
- Useu webhooks en lloc de polling per a actualitzacions en temps real
SDKs i biblioteques de client
Section titled “SDKs i biblioteques de client”Podeu integrar-vos amb l’API directament via HTTP o usant un SDK oficial. El primer SDK oficial és el PHP SDK:
Proporciona mètodes per a la gestió completa de factures, descàrregues de documents en múltiples formats, operacions completes d’informes fiscals (incloent Verifactu), utilitats de paginació i gestió d’errors. Es continuaran afegint SDKs addicionals per a altres llenguatges de programació.
Descarregar la Referència OpenAPI
Section titled “Descarregar la Referència OpenAPI”Podeu descarregar la referència completa de l’API REST en format OpenAPI (YAML) des dels següents enllaços: