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

O Jelou expõe dois domínios de acordo com o endpoint que você utiliza:
Cada endpoint indica em sua documentação o domínio e o método de autenticação que lhe corresponde. Confira o bloco Endpoint e Autenticação de cada recurso.

​
Autenticação

O método de autenticação depende do domínio do endpoint.

​
API Jelou (api.jelou.ai) legacy

Os clientes que usam esta API receberão um client ID e uma client secret key para autenticação básica. Para qualquer endpoint de api.jelou.ai, o seguinte cabeçalho deve ser adicionado:

​
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: bXlfY2xpZW50X2lkOm15X2NsaWVudF9zZWNyZXQ=
  3. Inclua no cabeçalho: Authorization: Basic bXlfY2xpZW50X2lkOm15X2NsaWVudF9zZWNyZXQ=

​
Gateway (gateway.jelou.ai)

Os endpoints publicados em gateway.jelou.ai são autenticados com uma API key no cabeçalho x-api-key:
Consulte Chaves API para criar e administrar suas chaves. Cada endpoint indica os scopes que requer.

​
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

​
Limites de taxa

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