Je API-key gebruiken
Gebruik je console-key bij aanvragen aan api.vlows.io, met de juiste rechten.
Je integratie gebruikt een API-key die je in de console aanmaakt. Inloggen met je e-mailadres, wachtwoord en tweestapsverificatie doe je in de console. Voor normaal API-gebruik is er geen gebruikerslogin: je stuurt je API-key mee met iedere aanvraag.
Het API-adres
De basis-URL is https://api.vlows.io. Voeg daar het pad van het gewenste endpoint aan toe, bijvoorbeeld /account/v1/usage. Gebruik HTTPS voor je aanvragen.
De Authorization-header
Stuur de volledige key in de HTTP-header, met één spatie tussen Bearer en de key:
Authorization: Bearer <jouw-api-key>
De key begint met vlw_. Vervang de placeholder door de sleutel die je eenmalig bij het aanmaken hebt ontvangen. Zet de key niet in de URL of een queryparameter.
API_URL=https://api.vlows.io
# API_KEY wordt ingelezen uit de geheime configuratie van je koppeling.
curl --fail-with-body --silent --show-error \
"$API_URL/account/v1/usage" \
-H "Authorization: Bearer $API_KEY"
Dit voorbeeld vereist het recht usage:read. Je hoeft voor een aanvraag geen e-mailadres, wachtwoord, authenticatorcode of consolecookie mee te sturen. De koppeling blijft werken wanneer je uitlogt uit de console, zolang de key geldig is.
Rechten per key
De rechten, of scopes, bepalen welke aanvragen je koppeling mag doen:
| Scope | Gebruik |
|---|---|
deliveries:read |
Eigen leveringen, gebeurtenissen, pogingen en vervoerders opvragen. |
deliveries:write |
Leveringen aanleveren of bijwerken, gebeurtenissen en pogingen melden, adressen controleren. |
usage:read |
Het API-gebruik van je organisatie opvragen. |
oracle:read |
Beschikbare oracle-inzichten raadplegen. |
Schrijfrecht omvat niet automatisch leesrecht. Selecteer beide als je koppeling beide nodig heeft. Alle aanvragen zijn gebonden aan de organisatie waarvoor de key is gemaakt.
De key bewaren
Bewaar de key in de geheime configuratie van je server of integratie, bijvoorbeeld een secretmanager of afgeschermde omgevingsvariabele. Gebruik hem vanuit je eigen backend. Zet hem niet in openbare frontendcode, een repository, een screenshot of een logbestand.
Een bestaande key is niet opnieuw volledig op te vragen. Ben je hem kwijt, maak dan in de console een nieuwe key en trek de oude in.
Vervangen en intrekken
Maak in de console een nieuwe key, pas de configuratie van je koppeling aan en controleer een testaanvraag. Trek daarna de oude key in. Bij een vermoeden van misbruik trek je de betrokken key direct in.
Na intrekken of verlopen worden nieuwe aanvragen geweigerd met 401. Een actieve key met onvoldoende rechten krijgt 403. Controleer de status en rechten in de console; zie Fouten & opnieuw proberen.