Todas las peticiones deben realizarse a:
<https://api.keiron.cl>
A esta URL base se le agrega la ruta específica de cada endpoint. Por ejemplo, para crear un Deal:
POST <https://api.keiron.cl/crm/integration-generic/deals>
| Término | Descripción |
|---|---|
| Flow | “Flujo”. Cada tablero de CRM con columnas y deals. |
| Status | “Estado”. Cada una de las columnas del tablero. |
| Deal | “Negocio”. Cada una de las tarjetas presentes en una columna del tablero. |
| Field | “Campo”. Cada una de las variables existentes en un deal. |
| Transition | “Transición”. Movimiento de un deal de un estado a otro. |
<aside> ☝🏼 Recomendado: A partir de 2024-08-01, la forma recomendada de autenticación es mediante token de integración permanente. Este token puede ser solicitado a tu contraparte en Keirón.
</aside>
Todas las peticiones requieren autenticación mediante Bearer Token en el header:
Authorization: Bearer <tu_token>
| Método | Descripción | Duración |
|---|---|---|
| Token permanente (recomendado) | Solicitar a Keirón | No expira |
| JWT temporal | Obtener via /authentication/login |
24 horas |
{
"success": true,
"data": { ... }
}
El campo data contiene la información específica de cada endpoint según su documentación.
{
"message": "Descripción del error",
"statusCode": 400
}
Todas las fechas deben enviarse en formato Unix timestamp (epoch). Esto evita problemas de zona horaria.
✅ Correcto: 1708050334
❌ Evitar: "2024-02-16" (puede causar problemas de timezone)
Las fechas se interpretan en UTC+0. Se recomienda siempre usar Unix timestamp.
Cuando la documentación indica :param en una ruta, debe reemplazarse por el valor correspondiente (incluyendo los dos puntos):
Documentación: /deals/:dealId
Ejemplo real: /deals/12345
| Código | Descripción |
|---|---|
200 |
Petición procesada exitosamente |
201 |
Recurso creado exitosamente |
| Código | Descripción |
|---|---|
400 |
Error de validación — revisa los parámetros enviados |
401 |
No autorizado — token inválido o expirado |
403 |
Prohibido — no tienes permisos para este recurso |
404 |
No encontrado — el recurso solicitado no existe |
429 |
Rate limit excedido — espera antes de reintentar |
| Código | Descripción |
|---|---|
500 |
Error interno del servidor |
Para garantizar una experiencia consistente para todos los usuarios de la API, se aplican límites de tasa (rate limits) a las peticiones entrantes.
Las peticiones que excedan los límites devolverán un código de error "rate_limited" (HTTP response status 429).
Los límites en la API pública son:
| Ventana | Límite |
|---|---|
| Por segundo | 50 peticiones |
| Por minuto | 3000 peticiones |
Se permiten ráfagas (bursts) que superen brevemente el promedio, siempre que el total dentro de la ventana no exceda los valores indicados.
<aside> <img src="/icons/exclamation-mark_red.svg" alt="/icons/exclamation-mark_red.svg" width="40px" />
Los rate limits pueden cambiar
A futuro podríamos ajustar los límites para equilibrar demanda y confiabilidad, e incluso introducir límites distintos según el plan contratado.
</aside>