APIv2 es una API pública disponible para desarrolladores que necesitan integrar la funcionalidad de Kommo IA en sus servicios. Actualmente, los métodos disponibles públicamente permiten realizar las siguientes acciones:
Respuesta sugerida IA
- Añadir fuentes.
Agente de IA
- Añadir fuentes con propiedades especiales - política.
- Sincronización de productos desde el CRM a IA.
Autorización
Token de autorización
Para la autorización de solicitudes en los endpoints públicos de la API, puedes utilizar tanto OAuth 2.0 como tokens de larga duración.
Este token debe enviarse en el encabezado Authorization:
authorization: Bearer <YOUR TOKEN>
Posibles respuestas negativas de autorización
{
"code": 401,
"status": "error",
"detail": "Algo salió mal. Por favor, contacta a nuestro equipo de soporte.",
"error_reason": "No token provided"
}
Este error ocurre si no se pasó el token de autorización en el encabezado esperado.
{
"code": 403,
"status": "error",
"detail": "Algo salió mal. Por favor, inténtalo de nuevo.",
"error_reason": "Bearer token verification failed"
}
En los casos en que no sea posible verificar la autenticidad del token, pueden producirse varios errores.
Este error ocurre si el servidor de autorización no ha confirmado que el token pertenece a la cuenta.
{
"code": 403,
"status": "error",
"detail": "Algo salió mal. Por favor, inténtalo de nuevo.",
"error_reason": "Error while getting account data via provided token"
}
Este error ocurre si no fue posible obtener los datos de la cuenta para continuar con el servicio. Generalmente sucede si llega una solicitud al servicio para esta cuenta por primera vez mediante un token OAuth2, ya que este no contiene una carga adicional. Sin embargo, esto solo puede ocurrir si el servicio no pudo comunicarse con el servicio principal.
Preprocesamiento de solicitudes
Antes de que la API procese la solicitud, se verifica:
- Qué idioma debe tener la respuesta (encabezado X-Language).
- Si el servicio está disponible actualmente.
- Si el acceso está permitido para tu cuenta.
Idioma
Esta propiedad es necesaria para mostrar textos localizados. De forma predeterminada, está configurada en inglés. Puede cambiarse pasando un encabezado especial en la solicitud:
X-Language: {en|es|pt|ru}
Valores válidos: en/es/pt/ru.
Si se pasa un idioma no compatible, se utilizará inglés de manera predeterminada.
Disponibilidad del servicio
Verificamos si el servicio está habilitado para Kommo. Si no está disponible, se retornará el siguiente error:
{
"code": 403,
"status": "error",
"detail": "IA temporalmente no disponible",
"error_reason": "Service unavailable"
}
Si ocurre este error, significa que se ha producido un problema importante en el servidor. Nuestros especialistas ya están trabajando en solucionarlo y el servicio se restaurará en breve. Solo puedes esperar a que se resuelva el error.
Disponibilidad del servicio para la cuenta
Para la plataforma Kommo, se realiza una verificación para comprobar si la cuenta puede acceder a este servicio. Hay dos posibles condiciones de bloqueo:
- El acceso se restringió manualmente para esta cuenta. Esto generará el siguiente error:
{
"code": 402,
"status": "error",
"detail": "IA temporalmente no disponible",
"error_reason": "Disabled for account"
}
- Esta cuenta ha superado su límite mensual de uso de la API. Esto generará el siguiente error:
{
"code": 402,
"status": "error",
"detail": "Has alcanzado tu límite mensual de solicitudes. Para seguir utilizando los prompts, por favor contacta a nuestro equipo de soporte.",
"error_reason": "Limit reached"
}