Authenticatie (Authentication)
Elk verzoek aan de Partner API moet worden geauthenticeerd met HMAC-SHA256-verzoekondertekening (request signing). Dit zorgt ervoor dat verzoeken zowel authentiek zijn als niet zijn gemanipuleerd tijdens het transport.
Vereiste headers
| Header | Beschrijving |
|---|---|
X-API-Key | Uw organisatie-API-sleutel |
X-Timestamp | Huidige Unix-tijdstempel in seconden (bijv. 1711000000) |
X-Nonce | Een unieke tekenreeks per verzoek (UUID v4 aanbevolen) |
X-Signature | HMAC-SHA256 hex-handtekening van het verzoek |
Handtekeningconstructie
De handtekening (signature) wordt berekend door een punt-gescheiden berichtreeks samen te stellen en deze te ondertekenen met uw API-sleutelgeheim:
message = "{timestamp}.{nonce}.{method}.{path}.{body}"
signature = HMAC-SHA256(apiKeySecret, message).hexDigest()
De berichtcomponenten, samengevoegd met punten (.):
- timestamp — Unix-tijdstempel in seconden (dezelfde waarde als de
X-Timestamp-header) - nonce — Dezelfde waarde als verzonden in de
X-Nonce-header - method — De HTTP-methode in hoofdletters (bijv.
GET,POST) - path — Het volledige verzoekpad (bijv.
/v2/partners/products/tickets) - body — De onbewerkte JSON-verzoektekst. Voor GET-verzoeken zonder body, gebruik een lege tekenreeks
""
De resulterende HMAC-digest moet worden gecodeerd als kleine letters hex.
Voorbeelden
API_KEY="your-api-key"
API_SECRET="your-api-secret"
TIMESTAMP=$(date +%s)
NONCE=$(uuidgen | tr '[:upper:]' '[:lower:]')
METHOD="GET"
REQ_PATH="/v2/partners/products/tickets"
BODY=""
MESSAGE="${TIMESTAMP}.${NONCE}.${METHOD}.${REQ_PATH}.${BODY}"
SIGNATURE=$(echo -n "${MESSAGE}" | \
openssl dgst -sha256 -hmac "${API_SECRET}" | \
awk '{print $2}')
curl -X GET "https://api.vignetim.com${REQ_PATH}" \
-H "Content-Type: application/json" \
-H "X-API-Key: ${API_KEY}" \
-H "X-Timestamp: ${TIMESTAMP}" \
-H "X-Nonce: ${NONCE}" \
-H "X-Signature: ${SIGNATURE}"Belangrijke opmerkingen
- De
X-Timestampmoet binnen 5 minuten (300 seconden) van de servertijd liggen. Verzoeken met verouderde tijdstempels worden geweigerd met een401-fout. - Elke
X-Nonce-waarde moet uniek zijn en kan slechts eenmaal worden gebruikt. Hergebruik van een nonce resulteert in een401-fout. - Gebruik altijd de onbewerkte, niet-opgemaakte JSON-body-tekenreeks voor de handtekeningberekening. Maak de body niet mooier op en serialiseer deze niet opnieuw voordat u ondertekent.
- De handtekening moet kleine letters hex-gecodeerd zijn. Gebruik geen base64.