Cost+Docs

Authenticatie

Leer hoe u zich authenticeert bij de Cost+ API

Alle communicatie met de Cost+ API vereist TLS 1.2 of hoger en HTTP Basic Authentication.

Hoe Basic Auth werkt

Authenticeer door uw API-sleutel als gebruikersnaam te gebruiken met een leeg wachtwoord. Base64-codeer de string \{api_key\}: (let op de afsluitende dubbele punt — het wachtwoord is leeg).

De resulterende Authorization-header ziet er als volgt uit:

Authorization: Basic aHVudGVyMjo=

Stel uw API-sleutel nooit bloot in client-side code of openbare repositories. Bewaar deze uitsluitend aan de serverzijde.

Gebruik van cURL

Standaard (aanbevolen)

cURL ondersteunt Basic Auth standaard met de -u-vlag. Geef uw API-sleutel op gevolgd door een dubbele punt:

cURL met -u vlag
curl -u YOUR_API_KEY: https://api.costplus.online/v1/orders/

Handmatige Base64-codering

Als u de header liever zelf opbouwt, codeer dan eerst de sleutel:

API-sleutel coderen
echo -n "YOUR_API_KEY:" | base64

Geef vervolgens de gecodeerde waarde door in de Authorization-header:

cURL met handmatige Authorization-header
curl -H "Authorization: Basic YOUR_BASE64_ENCODED_KEY" https://api.costplus.online/v1/orders/

De afsluitende dubbele punt na de API-sleutel is vereist — deze scheidt de gebruikersnaam van het (lege) wachtwoord in het Basic Auth-schema.

HTTP-statuscodes

De API gebruikt standaard HTTP-statuscodes om het resultaat van een verzoek aan te geven.

StatuscodeBetekenisBeschrijving
200OKVerzoek geslaagd.
201AangemaaktResource is succesvol aangemaakt.
400Ongeldig verzoekHet verzoek was onjuist geformuleerd of miste verplichte velden.
401Niet geautoriseerdAuthenticatie mislukt — controleer uw API-sleutel.
403VerbodenU heeft geen toestemming om toegang te krijgen tot deze resource.
404Niet gevondenDe gevraagde resource bestaat niet.
500Interne serverfoutEr is iets misgegaan aan onze kant.
502Bad GatewayUpstream-servicefout.
503Service niet beschikbaarDe API is tijdelijk niet beschikbaar.
504Gateway TimeoutDe upstream-service reageerde niet op tijd.

On this page