Firma de solicitudes CP-HMAC

Cada solicitud a /v1/* se firma con el secreto de la clave de API. El secreto en sí nunca se transmite por la red. Los clientes oficiales lo hacen por usted; esta sección es para quien escriba el suyo propio.

Cabecera

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

Qué se firma

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

• METHOD: GET, POST, etc.
• PATH_WITH_QUERY: la ruta y la cadena de consulta exactamente como se enviarán en la solicitud: /v1/invoices?status=paid&limit=50. El esquema y el host no se firman.
• El cuerpo se firma byte a byte. Firme la misma cadena JSON que va a enviar, no un objeto serializado de nuevo.
• Para solicitudes sin cuerpo, 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))

Valores de referencia

Coteje su implementación: los cuatro clientes oficiales se verifican con estos mismos valores.

Si recibe un 401

Cualquier error de firma devuelve 401 unauthorized con el mismo texto: el servidor no indica qué ha fallado exactamente. Causas habituales:

• el reloj del servidor se ha desviado más de 5 minutos: active NTP;
• se ha firmado otra ruta: sin la cadena de consulta o con los parámetros en otro orden;
• el cuerpo se ha vuelto a serializar después de firmarlo;
• se ha reutilizado un nonce;
• la clave está revocada.

403 merchant_suspended: la firma es correcta, pero el comercio está suspendido.

Claves

• Las claves se crean en el panel, en la sección «Claves y webhooks». El secreto se muestra una sola vez.
• Puede tener hasta 10 claves activas a la vez. Rotación: cree una nueva, cambie el servidor a ella y revoque la antigua. La revocación surte efecto de inmediato.
• Guarde el secreto en un gestor de secretos o en una variable de entorno del servidor, nunca en el código ni en git.
• Límite: unas 20 solicitudes por segundo por comercio, con margen para picos; si lo supera, recibirá 429 rate_limited.