Requests ondertekenen met CP-HMAC

Elk request aan /v1/* wordt ondertekend met het secret van de API-sleutel. Het secret zelf gaat nooit over het netwerk. De kant-en-klare clients regelen dit voor u — deze sectie is voor wie een eigen client schrijft.

Header

Authorization: CP-HMAC key=<key_id>, ts=<unix_seconds>, nonce=<nonce>, sig=<hex>

Wat wordt ondertekend

string = METHOD + "\n" + PATH_WITH_QUERY + "\n" + ts + "\n" + nonce + "\n" + hex(sha256(body))
sig    = hex(HMAC-SHA256(secret, string))

• METHOD — GET, POST enzovoort.
• PATH_WITH_QUERY — pad en querystring precies zoals ze in het request worden verstuurd: /v1/invoices?status=paid&limit=50. Schema en host worden niet ondertekend.
• De body wordt byte voor byte ondertekend. Onderteken exact de JSON-string die u verstuurt, niet een opnieuw geserialiseerd object.
• Voor requests zonder body geldt hex(sha256("")) = e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.

import { createHash, createHmac, randomBytes } from "node:crypto";

export function sign(keyId, secret, method, pathWithQuery, body = "") {
  const ts = Math.floor(Date.now() / 1000).toString();
  const nonce = randomBytes(16).toString("hex");
  const bodyHash = createHash("sha256").update(body).digest("hex");
  const sig = createHmac("sha256", secret)
    .update(`${method}\n${pathWithQuery}\n${ts}\n${nonce}\n${bodyHash}`)
    .digest("hex");
  return `CP-HMAC key=${keyId}, ts=${ts}, nonce=${nonce}, sig=${sig}`;
}

function cp_sign(string $keyId, string $secret, string $method, string $pathWithQuery, string $body = ''): string {
    $ts = (string) time();
    $nonce = bin2hex(random_bytes(16));
    $str = $method . "\n" . $pathWithQuery . "\n" . $ts . "\n" . $nonce . "\n" . hash('sha256', $body);
    $sig = hash_hmac('sha256', $str, $secret);
    return "CP-HMAC key=$keyId, ts=$ts, nonce=$nonce, sig=$sig";
}

import hashlib, hmac, secrets, time

def cp_sign(key_id: str, secret: str, method: str, path_with_query: str, body: bytes = b"") -> str:
    ts = str(int(time.time()))
    nonce = secrets.token_hex(16)
    msg = f"{method}\n{path_with_query}\n{ts}\n{nonce}\n{hashlib.sha256(body).hexdigest()}"
    sig = hmac.new(secret.encode(), msg.encode(), hashlib.sha256).hexdigest()
    return f"CP-HMAC key={key_id}, ts={ts}, nonce={nonce}, sig={sig}"

sig := cryptopayclient.SignRequest(secret, "POST", "/v1/invoices", ts, nonce, body)
req.Header.Set("Authorization", fmt.Sprintf("CP-HMAC key=%s, ts=%d, nonce=%s, sig=%s", keyID, ts, nonce, sig))

Testvectoren

Controleer uw implementatie: met dezelfde waarden worden ook alle vier officiële clients getest.

Als u 401 krijgt

Elke handtekeningfout geeft 401 unauthorized met dezelfde tekst: de server verraadt niet wat er precies mis is. Veelvoorkomende oorzaken:

• de serverklok wijkt meer dan 5 minuten af — schakel NTP in;
• er is een ander pad ondertekend — zonder query of met een andere volgorde van parameters;
• de body is na het ondertekenen opnieuw geserialiseerd;
• een nonce is hergebruikt;
• de sleutel is ingetrokken.

403 merchant_suspended — de handtekening klopt, maar de merchant is opgeschort.

Sleutels

• U maakt sleutels aan in het dashboard, sectie ‘Sleutels en webhooks’. Het secret wordt één keer getoond.
• Er kunnen maximaal 10 sleutels tegelijk actief zijn. Rotatie: maak een nieuwe aan, schakel uw server om en trek de oude in. Intrekken werkt direct.
• Bewaar het secret in een secret manager of een omgevingsvariabele op de server, niet in de code en niet in git.
• De limiet is ongeveer 20 requests per seconde per merchant, met ruimte voor pieken; daarboven krijgt u 429 rate_limited.