Pular para o conteúdo principal
A API Jelou é uma ferramenta poderosa para que empresas se comuniquem de forma mais profissional e eficiente com seus clientes por meio de chatbots. Ela permite a criação de sistemas complexos e interconectados, integrando-se perfeitamente à plataforma Jelou, a serviços externos e outros sistemas. Baseada em princípios REST, facilita a colaboração e a troca de informações, personalizando mensagens, mantendo o contexto do usuário e salvando o histórico de conversas. Na prática, a API Jelou permite que chatbots se comuniquem com outros sistemas, facilitando a colaboração, a troca de informações e a execução de diversas tarefas, como personalizar mensagens, manter o contexto do usuário ou garantir a continuidade salvando o histórico de conversas. Isso é fundamental para o desenvolvimento de aplicações modernas e interconectadas, possibilitando uma melhor experiência do usuário e conversas com múltiplos turnos. A API sempre responderá com um objeto e, dependendo do contexto, os recursos podem responder com um objeto simples ou um array de objetos.
Esta API aceita corpos de requisição no formato JSON e exige que o conteúdo inclua o cabeçalho Content-Type: application/json. Esse cabeçalho deve ser especificado em cada requisição.

​
Domínio

A API Jelou está disponível no seguinte domínio: 
https://api.jelou.ai

​
Autenticação

Os clientes que usam esta API receberão um client ID e uma client secret key para autenticação básica. Para qualquer endpoint da API, o seguinte cabeçalho deve ser adicionado: 
Authorization: Basic <Base64 encoded clientId:clientSecret>

​
Exemplo

Se o seu clientId é my_client_id e o seu clientSecret é my_client_secret:
  1. Una-os com dois pontos: my_client_id:my_client_secret
  2. Codifique em Base64: bWlfY2xpZW50X2lkOm1pX2NsaWVudF9zZWNyZXQ=
  3. Inclua no cabeçalho: Authorization: Basic bWlfY2xpZW50X2lkOm1pX2NsaWVudF9zZWNyZXQ=

​
Erros

A Jelou usa os padrões HTTP para reportar erros. Em geral:
  • Códigos 2XX indicam sucesso.
  • Códigos 4XX indicam erros do cliente.
  • Códigos 5XX indicam erros do servidor.
Quando ocorre um erro, a resposta inclui um objeto JSON com um code e uma description detalhada do problema.

​
Códigos de erro

CódigoCódigo de status HTTPDescrição
bot_not_found404A empresa não tem permissão para usar este bot.
forbidden_bot403Você não tem permissão para usar este bot.
message_could_not_be_send400A mensagem não pôde ser enviada devido a uma requisição inválida.
notification_could_not_be_send400A notificação não pôde ser enviada devido a uma requisição inválida.
unauthorized401Você não está autorizado a realizar esta requisição.
unprocessable_entity422Um campo está ausente ou há um erro na requisição.
internal_server_error500O token de autorização não tem uma empresa atribuída.

​
Limites de taxa

A API tem um limite de 5 requisições por segundo.