APIv2 é uma API pública disponível para desenvolvedores que precisam integrar funcionalidades da Kommo IA aos seus serviços. Atualmente, métodos disponíveis publicamente permitem que você performe as seguintes ações:
Resposta Sugerida por IA
- Adicionar fontes
Agente de IA
- Adicionar fontes com propriedades especiais - políticas
- Sincronização de produtos do CRM para a IA
Autorização
Token de autorização
Para autorizaçãod e requisições feitas para endpoints públidos de API, você pode usar tanto o OAuth 2.0 quanto o Token de longa duração.
Esse token deve ser enviado no cabeçalgo de autorização:
authorization: Bearer <SEU TOKEN>Possíveis respostas de autorização negativas
{
"code": 401,
"status": "error",
"detail": "Algo deu errado. Por favor, entre em contato com nossa equipe de suporte.",
"error_reason": "No token provided"
}Esse erro ocorre quando o token de autorização não foi passado no cabeçalho esperado.
{
"code": 403,
"status": "error",
"detail": "Algo deu errado. Por favor, tente novamente.",
"error_reason": "Bearer token verification failed"
}Em casos onde é impossível verificar a autenticidade de um token, múltiplos erros podem ocorrer.
Esse erro ocorre caso o servidor de autorização não tenha confirmado que o token pertence à conta.
{
"code": 403,
"status": "error",
"detail": "Algo deu errado. Por favor, tente novamente.",
"error_reason": "Error while getting account data via provided token"
}Esse erro acontece quando não é possível obter dados da conta para continuar com o serviço. Na maioria das vezes, isso acontece caso uma requisição para o servidor da conta seja feita pela primeira vez usando um token Oauth2, pois ele não possui uma carga adicional. Porém isso só ocorre se o servidor for incapaz de alcançar a raiz do serviço.
Pré processamento de requisições
Antes da API processar as requisições, ela checa:
- Em qual lingua a resposta deveria estar (Cabeçalho X-Language)
- Se o servidor está atualmente disponível
- Se o acesso foi permitido em sua conta.
Linguagem
Essa propriedade é necessária para a exibição de textos na língua local. Por padrão, ela está definida para o Inglês. Ela pode ser alterada passando um cabeçalho de pesquisa especial:
X-Language: {en|es|pt|ru}Valores válidos: en/es/pt/ru
Se uma linguagem não suportada for passada, o Inglês será utilizado por padrão
Disponibilidade do serviço
Nós checamos se o serviço está habilitado na Kommo. Caso não esteja disponível, o seguinte erro será retornado:
{
"code": 403,
"status": "error",
"detail": "IA temporariamente indisponível",
"error_reason": "Service unavailable"
}Caso esse erro ocorra, isso significa que um problema relevante aconteceu no lado do servidor. Nossos especialistas já estão trabalhando nisso, e o serviço será reestabelecido em breve. Nesse momento, é necessário aguardar até que o erro seja resolvido.
Disponibilidade do serviço para a conta
Para a plataforma Kommo, é feita uma checagem para verificar se a conta pode acessar o serviço. Existem duas condições de bloqueio possíveis:
- O acesso foi manualmente restringido para essa conta. Isso irá gerar o seguinte erro:
{
"code": 402,
"status": "error",
"detail": "AI temporarily unavailable",
"error_reason": "Disabled for account"
}- Essa conta excedeu o limite mensal de uso da API. Isso vai resultar no seguinte erro:
{
"code": 402,
"status": "error",
"detail": "Você atingiu seu limite mensal de solicitações. Para continuar usando os avisos, entre em contato com nossa equipe de suporte.",
"error_reason": "Limit reached"
}