De API maakt gebruikt van REST met API-sleutel of e-mailadres/wachtwoord (basic authentication). Het is aan te raden om een API-sleutel te gebruiken.

API-sleutel

Per account kunnen één of meerdere API-sleutels (API key) worden aangevraagd via “Toegangsbeheer”. Een API-sleutel biedt steeds toegang tot één specifieke account.

De API-sleutel wordt meegegeven tijdens de aanvraag naar de API via de header “X-API-Key”.

Basic authentication

Toegang tot de API is ook mogelijk door het e-mailadres en wachtwoord van een gebruiker mee te geven. Dit kan via de standaard basic authentication methode waarbij het e-mailadres (username) en wachtwoord (password) worden doorgegeven via de header “Authorization”. De waarde van de header begint met “Basic ” gevolgd door een base64 encodering van “username:password”.

Het is aan te raden om een afzonderlijke gebruiker aan jouw account toe te voegen die enkel bij API-toegang wordt gebruikt. Zo heb je geen nood aan de credentials van de normale gebruikers.

Indien een gebruiker toegang heeft tot verschillende accounts kan je het gewenste account doorgeven in de header via “X-AccountId”. Het account-nummer (AccountId) van een account kan je opvragen via de account-pagina (zie instellingen-menu rechtsboven). Wordt er geen account-nummer opgegeven dan wordt de standaard account van de gebruiker gebruikt (in te stellen langs de gebruiker-pagina (zie instellingen-menu rechtsboven).

Nieuwe API-sleutel aanmaken

Vanuit de API kan ook een nieuwe API-sleutel worden aangemaakt voor een account. Om een nieuwe API-sleutel aan te maken kan een POST-call worden uitgevoerd naar /api/v1/apikeys door gebruik te maken van de bovenstaande basic authentication. Bij het oproepen van de call moet een name (verplicht) en rights (niet verplicht; standaard alle rechten) worden opgegeven.