Introducción

Base URL

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>

Glosario de Términos

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.

image.png


Autenticación

<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>

Opciones de autenticación

Método Descripción Duración
Token permanente (recomendado) Solicitar a Keirón No expira
JWT temporal Obtener via /authentication/login 24 horas

Convenciones Generales

Formato de Respuestas

Respuesta exitosa

{
  "success": true,
  "data": { ... }
}

El campo data contiene la información específica de cada endpoint según su documentación.

Respuesta con error

{
  "message": "Descripción del error",
  "statusCode": 400
}

Formato de Fechas

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.

Path Parameters

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ódigos de Estado

Respuestas Exitosas

Código Descripción
200 Petición procesada exitosamente
201 Recurso creado exitosamente

Errores del Cliente

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

Errores del Servidor

Código Descripción
500 Error interno del servidor

Endpoints

Public CRM Endpoints Database