KuikCodeDocs
API

Introducción

Crea KuikCodes, cambia a dónde apunta un código impreso, lee escaneos y administra carpetas y webhooks desde tus propios sistemas.

La API de KuikCode es una API REST JSON disponible en:

https://api.kuikcode.com/v1

Está incluida desde el plan PRO. Crea una clave en Configuración, Desarrolladores en el panel y envíala como token bearer; consulta Autenticación.

Una primera solicitud

curl https://api.kuikcode.com/v1/me \
  -H "Authorization: Bearer kc_live_..."

GET /me devuelve la clave con la que estás llamando, su espacio de trabajo, los límites del plan y el uso actual. Es la primera llamada que debería hacer toda integración.

Crea un código

curl -X POST https://api.kuikcode.com/v1/codes \
  -H "Authorization: Bearer kc_live_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 5f3a9c2e-order-8812" \
  -d '{
    "name": "Spring menu, table tents",
    "destination": { "type": "url", "url": "https://example.com/spring-menu" },
    "tags": ["spring", "print"]
  }'

La respuesta incluye el id del código, su shortCode permanente y la scanUrl que codifica el diseño. Descarga el diseño con GET /codes/{id}/image?format=png (también svg y jpg).

Cambia a dónde apunta un código impreso

curl -X PATCH https://api.kuikcode.com/v1/codes/K02bEPC2SmtopwPr6S-jt \
  -H "Authorization: Bearer kc_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "destination": { "type": "url", "url": "https://example.com/summer-menu" } }'

El diseño nunca cambia.

Convenciones

  • JSON de entrada y de salida, UTF-8 y marcas de tiempo ISO 8601 en UTC.
  • Las listas se paginan con un cursor opaco; consulta Paginación.
  • Los errores comparten una misma forma y un conjunto estable de códigos; consulta Errores.
  • Todo POST acepta un Idempotency-Key; consulta Idempotencia.
  • Los presupuestos son por clave y por minuto; consulta Límites de frecuencia.

Guías

OpenAPI

El contrato completo está publicado como OpenAPI 3.1 en https://api.kuikcode.com/v1/openapi.json. Las páginas de referencia de esta sección se generan a partir de él.

En esta página