Authentifizierung

HMAC-Anfragesignatur

Alle /v1/*-Endpunkte einschließlich GET erfordern HMAC-SHA256. Die Prüfung erfolgt durch zeitkonstanten Vergleich gegen Timing-Angriffe.

Sie möchten direkt ausführbare Dateien? Öffnen Sie die Integrationsseite für Beispiele, Postman und .http mit derselben Signaturformel.

Integration ansehen

Erforderliche Header

Die ersten 4 Header sind für jede Anfrage erforderlich. Quelle ist das Sicherheitsschema in openapi.json.

Header	Typ	Bedeutung
`X-TKE-Key`	jede Anfrage	Öffentliche key_id (tke_live_… / tke_test_… / tke_member_live_… / tke_member_test_…)
`X-TKE-Timestamp`	jede Anfrage	Epoch in Millisekunden (Ganzzahl als Text)
`X-TKE-Nonce`	jede Anfrage	Je Anfrage eindeutige UUID v4 oder v7
`X-TKE-Signature`	jede Anfrage	HMAC-SHA256 als Hex in Kleinbuchstaben
`Idempotency-Key`	5 Endpunkte	Vom Client erzeugte Zeichenfolge: Gleicher Schlüssel und gleicher Body werden einmal ausgeführt; Wiederholungen liefern das erste Ergebnis. Gilt je `api_key_id` (§11): zwei Schlüssel sind getrennte Befehle.

Pflicht-Endpunkte für Idempotency-Key

POST/v1/ordersPOST/v1/orders/bulkPOST/v1/esims/{id}/cancelPOST/v1/esims/{id}/change-planPOST/v1/esims/{id}/refund-requests

Kanonische Signaturformel

HMAC-SHA256-Authentifizierung (§4). Vier Header senden: X-TKE-Key (öffentliche key_id), X-TKE-Timestamp (Epoch in ms), X-TKE-Nonce (UUID pro Anfrage), X-TKE-Signature (Hex in Kleinbuchstaben). signing_string = method path timestamp nonce body_hash; body_hash = SHA256(raw_body) als Hex. Vergleich in konstanter Zeit. path ENTHÄLT den Query-String.

Segmente werden durch Zeilenumbrüche verbunden \n (LF), signiert über SHA256(raw_body) statt direkt über den Body. Der Server hasht die exakt empfangenen Bytes erneut.

text

signing_string = method + "\n"
               + path + "\n"        # mit Query, ohne Schema/Host
               + timestamp + "\n"   # = header X-TKE-Timestamp (epoch ms)
               + nonce + "\n"       # = header X-TKE-Nonce
               + body_hash          # SHA256(raw_body) hex lowercase

signature = HMAC_SHA256(secret, signing_string)   → hex lowercase

Bei GET, DELETE oder leerem Body, raw_body = "" → body_hash = SHA256("") = e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.

HMAC-Signaturbeispiele

secret und key_id ersetzen. Exakt gehashte Bytes senden, nach Signatur nicht erneut serialisieren.

bash

#!/usr/bin/env bash
# Yeu cau: openssl. Ky POST /v1/orders.
KEY_ID="tke_test_ab12cd34..."
SECRET="tke_secret_test_0123456789abcdef"
METHOD="POST"
PATH_Q="/v1/orders"
BODY='{"items":[{"package_code":"THAY-BANG-MA-GOI-CUA-BAN","quantity":2}]}'
TS="$(date +%s000)"                 # epoch milliseconds
NONCE="$(uuidgen)"

BODY_HASH="$(printf '%s' "$BODY" | openssl dgst -sha256 -hex | awk '{print $NF}')"
SIGNING="$METHOD"$'
'"$PATH_Q"$'
'"$TS"$'
'"$NONCE"$'
'"$BODY_HASH"
SIG="$(printf '%s' "$SIGNING" | openssl dgst -sha256 -hmac "$SECRET" -hex | awk '{print $NF}')"

curl -sS "https://api.tongkhoesim.com$PATH_Q"   -H "X-TKE-Key: $KEY_ID"   -H "X-TKE-Timestamp: $TS"   -H "X-TKE-Nonce: $NONCE"   -H "X-TKE-Signature: $SIG"   -H "Idempotency-Key: $(uuidgen)"   -H "Content-Type: application/json"   --data-raw "$BODY"

Backend-Testvektoren

Prüfen Sie Ihre Implementierung mit diesen vom Backend erzeugten Vektoren.

Die exakten Eingaben unten signieren und vergleichen. Bei Abweichung signing_string prüfen.

Beispielgeheimnis: tke_secret_test_0123456789abcdef

POST /v1/orders

methodPOST

path/v1/orders

timestamp1720680000000

nonce11111111-1111-4111-8111-111111111111

raw_body{"items":[{"package_code":"VN_5GB_30D","quantity":2}]}

body_hashc197853f7fe46a9f2de1478e565c48ef9369d0152af5117434be8ccfa9391b31

signing_string

POST
/v1/orders
1720680000000
11111111-1111-4111-8111-111111111111
c197853f7fe46a9f2de1478e565c48ef9369d0152af5117434be8ccfa9391b31

signature (erwartetes Ergebnis)

97147afdebb5d15cf8441278ef524ce15c715ca95962ddb1cb2604a1672fc5d5

GET /v1/wallet/balance

methodGET

path/v1/wallet/balance

timestamp1720680000000

nonce22222222-2222-4222-8222-222222222222

raw_body(leer)

body_hashe3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855

signing_string

GET
/v1/wallet/balance
1720680000000
22222222-2222-4222-8222-222222222222
e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855

signature (erwartetes Ergebnis)

ab16941884d407924c7b15dea008d6f1d8c0c1be96dca3745344218a99257dbe