Untitled

Documentación pública CRM

En esta documentación se encuentran las descripciones de los endpoints disponibles públicamente para conectarse a la API de Keirón CRM.

Todas las peticiones, a no ser que se especifique lo contrario, utilizan autenticación con Bearer token JWT temporal según se especifica en Authorization.

De igual forma, para todos los endpoints, a menos que se especifique lo contrario, la ruta base a utilizar es

https://api.keiron.cl

A esta ruta base se le debe agregar la ruta descrita en cada endpoint particular.

Glosario de términos

Se definen a continuación algunos términos que se utilizan a lo largo de esta documentación y tienen relación con conceptos del CRM. Para cada uno se utilizan indistintamente cualquiera de sus sinónimos.

  1. Deal: “negocio”. Cada una de las tarjetas presentes en una columna del negocio.
  2. Flow: “flujo”. Cada tablero de CRM con columnas y deals.
  3. Field: “campo”. Cada una de las variables existentes en un deal en un tablero.
  4. Status: “estado”. Cada una de las columnas del tablero

Consideraciones generales

  1. Todas las respuestas exitosas, a menos que se indique lo contrario, siguen el siguiente formato

    {
	success: boolean;
	data: any;
}

    El parámetro success indica que la petición fue existosa, mientras que el parámetro data contiene toda la información que el endpoint entrega según se indica en la descripción de cada uno. Por simplicidad, en cada endpoint solo se especifica lo que viene dentro del parámetro data.

    A su vez, las respuestas con error siguen el siguiente formato

    {
	message: string | string[];
	statusCode: number;
}

    Con statusCode el código de error y message una descripción humana del error ocurrido

  2. Cuando esta documentación menciona para la ruta de un endpoint un texto de la forma :string (”dos puntos string”, ej: :dealId), está haciendo referencia a un path param, una “variable de ruta” que debe ser reemplazada por el valor deseado. El reemplazo incluye el signo : (”dos puntos”), así, por ejemplo, la ruta /deals/:dealId para el deal 475 se transforma en /deals/475.

  3. Todas las fechas, a menos que se indique lo contrario, deben ser enviadas en formato unix epoch (Link externo: ¿Qué es epoch?). De esta forma, es el equivalente a que todas las fechas estén en zona horaria UTC+0.

    Si bien el servidor acepta fechas en formato aaaa-mm-dd, va a interpretar cualquier fecha recibida como UTC+0, lo que puede causar problemas según la zona horaria de la máquina que envía, la zona horaria configurada en el flujo de CRM y la zona horaria del computador desde donde se visualiza el tablero. Se recomienda siempre usar el formato unix timestamp como estándar.