Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cobrix.co/llms.txt

Use this file to discover all available pages before exploring further.

API Key

Todos los endpoints de pagos requieren autenticación mediante el header X-API-Key.
X-API-Key: sk_live_acme_PqL9Kx2Yj7mN8vZqWpTr3bS5dF...

Formato de la key

sk_{environment}_{companySlug}_{random}
PrefijoAmbiente
sk_live_*Producción
sk_test_*Sandbox / pruebas

Obtener una API key

Las API keys las crean los administradores de la empresa desde el dashboard de Cobrix o mediante la API de administración de keys.
El texto completo de la key se muestra una sola vez en el momento de la creación. Guárdala de inmediato en un gestor de secretos.

Ejemplo de request autenticado

curl -X GET "https://api.cobrix.co/api/external/payments/{id}" \
  -H "X-API-Key: sk_live_acme_PqL9Kx2Yj7mN8vZ..."

Requisitos de seguridad

Nunca expongas tu API key:
  • No la incluyas en código frontend
  • No la subas a repositorios (públicos o privados)
  • No la registres en logs
  • Usa HTTPS en todas las requests.
  • Almacena la key en variables de entorno o en un secret manager.
  • Cuando sea posible, configura allowlists de IP para keys de producción.
  • Rota las keys periódicamente con el endpoint /rotate.

Errores de autenticación

CódigoCausaSolución
401API key faltante, inválida o revocadaVerifica el header X-API-Key
403IP no está en la allowlistAgrega la IP o usa una key sin restricción
400Cliente inactivoContacta a soporte — problema de datos legacy

Ejemplo de error

{
  "statusCode": 401,
  "message": "Invalid or revoked API key",
  "error": "Unauthorized",
  "timestamp": "2026-03-26T14:30:00.000Z",
  "path": "/api/external/payments"
}

Rate limits

Cada API key tiene un límite por defecto de 60 requests/minuto. Ver Rate Limiting para estrategias de reintento.