Integración API

Especificaciones técnicas para la integración de API.

1. URL base

La URL de tu endpoint se muestra en la página de detalles del endpoint.

POST

https://api.chikage.io/api/v1/data/{slug}

GET / PUT / DELETE

https://api.chikage.io/api/v1/data/{slug}/{record_id}

2. Autenticación

Incluye tu clave API en el encabezado.

Encabezado	Descripción	Obligatorio
Authorization	`Bearer tm_test_xxx...` / `Bearer tm_live_xxx...`	Yes
Content-Type	`application/json`	Yes
X-Webhook-Callback	URL del webhook	No
X-Webhook-Auth	Valor de autenticación (ej., token Bearer)	No
X-Webhook-Auth-Header	Nombre del encabezado de autenticación	No

3. Formato de solicitud

Content-Type: Solo application/json
Tamaño máximo: 100KB por solicitud
Método: POST / GET / PUT / DELETE

Endpoints CRUD

Cada endpoint soporta automáticamente cuatro métodos HTTP:

Método	Ruta	Descripción
`POST`	`/api/v1/data/{slug}`	Crear un nuevo registro (asíncrono, en cola)
`GET`	`/api/v1/data/{slug}/{record_id}`	Recuperar un registro por ID
`PUT`	`/api/v1/data/{slug}/{record_id}`	Reemplazar un registro por ID (asíncrono, en cola)
`DELETE`	`/api/v1/data/{slug}/{record_id}`	Eliminar un registro por ID (asíncrono, en cola)

GET, PUT, DELETE requieren un ID de registro devuelto de una respuesta POST anterior.

POST — Crear:

curl -X POST https://api.chikage.io/api/v1/data/{slug} \
  -H "Authorization: Bearer tm_test_xxx" \
  -H "Content-Type: application/json" \
  -d '{
  "order_id": "ORD-2024-001",
  "amount": 45000,
  "items": ["Item A", "Item B"],
  "paid": true
}'

GET — Leer:

curl https://api.chikage.io/api/v1/data/{slug}/rec_abc123 \
  -H "Authorization: Bearer tm_test_xxx"

PUT — Actualizar:

curl -X PUT https://api.chikage.io/api/v1/data/{slug}/rec_abc123 \
  -H "Authorization: Bearer tm_test_xxx" \
  -H "Content-Type: application/json" \
  -d '{
  "order_id": "ORD-2024-001",
  "amount": 50000,
  "items": ["Item A", "Item B", "Item C"],
  "paid": true
}'

DELETE — Eliminar:

curl -X DELETE https://api.chikage.io/api/v1/data/{slug}/rec_abc123 \
  -H "Authorization: Bearer tm_test_xxx"

4. Formato de respuesta

Respuesta exitosa (202):

{
  "success": true,
  "id": "rec_abc123",
  "message": "Request queued"
}

Ejemplo de respuesta de error (400):

{
  "success": false,
  "error": "Validation failed",
  "details": [
    { "field": "order_id", "error": "Required field is missing" }
  ]
}

Respuestas de error:

Code	Status	Description
`400`	Solicitud incorrecta	JSON inválido o campos obligatorios faltantes
`401`	No autorizado	Clave API faltante o inválida, o clave API desactivada por el propietario
`403`	Prohibido	Endpoint inactivo o suscripción expirada
`415`	Tipo de medio no soportado	Content-Type debe ser application/json
`429`	Demasiadas solicitudes	Límite de frecuencia mensual excedido
`5xx`	Error del servidor	Error interno del servidor (500, 502, 503, etc.)

5. Webhook del colaborador

Los colaboradores API pueden recibir resultados de procesamiento directamente.

Política de reintentos: Hasta 3 reintentos en caso de fallo (intervalos de 60 segundos)

6. Herramientas de prueba

Prueba en Sandbox antes de salir en vivo.

Página de prueba integrada: Accede mediante el botón Probar en la página de detalles del endpoint — sin herramientas adicionales necesarias
cURL: Prueba desde la línea de comandos
Postman: Usa la herramienta de prueba de API

7. Consola de producción

Después de desplegar a Producción, el propietario del endpoint puede gestionar los datos de producción directamente desde el panel — sin herramientas API externas ni código.

Cómo acceder

Ve a Detalle del endpoint → pestaña Producción → haz clic en "Abrir consola" para abrir en una nueva pestaña.

Características

Soporte CRUD completo (POST / GET / PUT / DELETE) en datos de producción
La clave API de producción se configura automáticamente — no se necesita entrada manual
Las solicitudes desde la consola no activan webhooks

Solo propietario

Solo el propietario del endpoint puede acceder a la Consola de producción. Los colaboradores no pueden usarla.