Docs

Resumen de la API

Autenticación, formato de errores y superficie de endpoints.

Autenticación

Todo /v1/* se autentica con una clave de API en Authorization: Bearer <key>. El prefijo selecciona el entorno (test/live) y el tipo (pk/sk). Los endpoints marcados como sk-only rechazan las claves pk_ con 403.

Formato de error

{ "code": "validation_failed", "message": "…", "hint": "cómo arreglarlo", "issues": [{ "path": "…", "message": "…" }] }

Endpoints

  • POST /v1/consent (y /batch), POST /v1/preferences: registrar (con Idempotency-Key)
  • POST /v1/preferences/confirmation-token: solicitar email de doble opt-in
  • GET /v1/subjects/{ref}/consent · /consent/history (sk) · /preferences · /preferences/history (sk)
  • POST /v1/subjects (sk) · /subjects/{ref}/identifiers (sk) · /subjects/merge (sk)
  • GET /v1/purposes · /purposes/{key}/current · /preference-template
  • GET /v1/policy?country= · /v1/banner (pk) · /v1/cookies
  • GET /v1/consent/tcstring · /v1/consent/google-consent-mode · /v1/consent/google-additional-consent · /v1/consent/gpp
  • GET /v1/tcf/vendor-list · GET /v1/receipts/{id} · GET /.well-known/jwks.json
  • POST /v1/data-requests (sk) · POST /v1/data-requests/portal (pk)
  • GET /v1/webhook-events: el catálogo de eventos de webhook y el contrato de entrega (cualquier clave)

La referencia completa, navegable y con opción de “probar ahora”, está en /reference.

AnteriorRegistro de auditoría