Hoe kan ik toegang krijgen tot de API?

De interactieve documentatie van de Billnado API vind je op api.billnado.be/documentation. Deze URL is publiek toegankelijk en mag vrij worden gebruikt en gedeeld. Daar kun je de beschikbare endpoints, requestmodellen en responses bekijken. Voor het uitvoeren van beveiligde API-aanroepen is wel authenticatie vereist.

API-definities

De API-documentatie is opgedeeld in meerdere definities die aansluiten bij verschillende groepen binnen de software. Enkele voorbeelden zijn client, account, support en accountant. Elke definitie bevat de endpoints die bij die groep horen.

Je kunt in de documentatie de gewenste definitie selecteren. De beschikbare endpoints en de toegang ertoe kunnen per definitie verschillen en zijn afhankelijk van je rechten.

Authenticatie

De API-documentatie voorziet twee manieren om je aan te melden:

1. OAuth 2.0
2. Een Personal Access Token (PAT)

OAuth 2.0

OAuth 2.0 is momenteel de ondersteunde authenticatiemethode. Gebruik deze methode om je toepassing veilig toegang te geven tot de API namens een Billnado-account.

Personal Access Token

Ondersteuning voor Personal Access Tokens is voorzien, maar nog niet beschikbaar. Je kunt momenteel nog geen PAT aanvragen of gebruiken. Deze mogelijkheid wordt in een toekomstige versie toegevoegd.

Gebruik tot die tijd OAuth 2.0 om toegang te krijgen tot de Billnado API.