Integrações personalizadas 101

Integrações com o Chatlayer, como funciona?

Você gostaria de começar sua jornada de integração com o Chatlayer? Ótima escolha!

Esta página ajudará você a começar e a orientar no caminho certo.

Escolha sua integração

O Chatlayer oferece várias formas de integração, cada uma com suas próprias possibilidades.

plugin de API

A integração via API é uma integração que permite fazer chamadas de API ao seu servidor e processar o resultado conforme respondido pelo seu servidor. Você pode encontrar isso em um bloco Ação > API.

Você deve usar melhor a API quando quiser fazer uma chamada de API ao seu servidor para os seguintes casos de uso:

• Para criar facilmente uma requisição GET ou POST apenas preenchendo os cabeçalhos e parâmetros.

• Quando você quer que seu servidor responda a uma mensagem específica.

• Quando você quer obter detalhes para serem armazenados na sessão a partir do seu servidor.

• Integrar com sua própria API onde você pode fazer alterações, se necessário.

Você deve ter seu próprio serviço quando quiser configurar isso. O serviço/API deve responder no mesmo formato que o Chatlayer espera. O formato que o Chatlayer espera pode ser encontrado aqui. Para mais informações sobre integração via API visite esta página.

Chatlayer v1 REST API

Nossa própria API REST JSON, conforme descrita em nosso documentação da API, pode ser usada para fazer chamadas de API para o Chatlayer e pode ser usada como outra forma de integrar seu serviço ao Chatlayer.

Um dos casos de uso mais comuns ao usar a API do Chatlayer (REST JSON) seria integrar o canal Webhook. Também fornecemos uma variedade de serviços via nossa API, alguns dos quais são:

• Obter todas as conversas

• Obter todas as mensagens em uma conversa

• Enviar mensagens

• Definir sessão

• Pausar/retomar o bot

• Disparar um bloco específico do bot

• Extrair o NLP de uma expressão

• Enviar mensagens de usuário vindas do seu canal Webhook

Ao fazer requisições à API do Chatlayer, o Chatlayer espera que um token bearer seja enviado para autorização. Em caso de token não autorizado, respondemos com 401 Não autorizado código de status.

Alguns endpoints têm limite de taxa e isso pode ser verificado checando os cabeçalhos conforme definido abaixo:

HTTP/1.1 200 OK
x-ratelimit-limit: 1200
x-ratelimit-remaining: 1199
x-ratelimit-reset: 1609459200000

• x-ratelimit-limit - o teto do limite de taxa que é aplicável à requisição atual.

• x-ratelimit-remaining - o número de requisições restantes para a janela de limite de taxa atual.

• x-ratelimit-reset - o momento em que o limite de taxa é redefinido, especificado em tempo epoch UTC (em segundos) editor de código

Os exemplos de requisição podem ser vistos no lado direito da página para cada requisição. Algumas das respostas de exemplo também podem ser vistas na parte inferior direita da página.

Você pode expandir todo o esquema do corpo da requisição para encontrar todos os esquemas dos objetos que podem ser enviados como requisição para a API do Chatlayer como mostrado na imagem abaixo e nesta página.

Editor de Código

No editor de código, você pode facilmente adicionar seu código personalizado (em JavaScript) ao fluxo do bot. Você pode usar este plugin para fazer chamadas de API personalizadas para seus servidores ou de terceiros para gerenciar e exibir a resposta que é enviada de volta. Esta é uma ferramenta muito versátil que fornecemos e que ajuda a adicionar lógica personalizada ao bot.

Para começar a construir com esta integração, você precisa de nada mais do que conhecimento (básico) em Javascript.

Você deve usar melhor o editor de código se quiser:

• Adicionar lógica personalizada ao bot, decidindo para onde o fluxo deve ir em seguida. Isso também pode ser feito com Ir Para, mas o editor de código permite condições mais complexas do que o Ir Para.

• Usar a resposta enviada pelo servidor durante uma chamada de API e querer primeiro analisar os dados enviados pelo servidor antes de processá-los further.

• Integrar com APIs de terceiros, por exemplo criar um ticket em um sistema de tickets externo

Para alguns exemplos de como usar o editor de código, confira este POST ou GET exemplo.

canal Webhook

O canal Webhook é mais indicado quando você quer usar nosso incrível mecanismo de NLP e o fluxo do bot fornecido pelo Chatlayer junto com sua própria página personalizada que lida com a interface de chat. A integração Webhook também pode ser usada se você quiser integrar um bot no Chatlayer com outro bot que você tem rodando em outro lugar.

O conceito por trás desta integração é que o Chatlayer trabalhará nos bastidores para processar suas consultas e então, uma vez que a consulta seja processada, o Chatlayer chamará sua API com o resultado. Isso torna esta integração mais leve e pode ser facilmente integrada com outros canais. Para tarefas intensivas de processamento, você não precisa ficar esperando a resposta do Chatlayer, pois nós chamaremos sua URL de API quando o processamento estiver concluído.

Você pode ativar o canal Webhook na página 'Canais' na plataforma. Tudo o que você precisa fazer é fornecer a URL onde precisamos fazer a chamada de API quando a requisição do webhook for processada.

Para mais informações sobre o canal Webhook visite esta página.

Como começar

Agora você escolheu qual tipo de integração é melhor para seu bot, ótimo!

Agora, você precisará começar a mapear como sua integração será.

Para cada integração, exceto o canal Webhook, é importante visualizar quais informações você precisa primeiro coletar do usuário antes de enviá-las ao sistema externo. Por exemplo, ao criar um ticket em um sistema de tickets externo, primeiro decida quais variáveis você precisa, como categoria, descrição, endereço de e-mail etc. Em seguida, certifique-se de que todas essas variáveis sejam enviadas corretamente para o sistema de tickets externo.

Com integrações de resposta, você precisará visualizar o que gostaria de fazer com cada resposta do sistema externo. Quais respostas você pode receber desse sistema? Existe uma lógica que faz com que a resposta X leve a um bloco diferente no Chatlayer do que a resposta Y?

Fazer essas perguntas antecipadamente e preparar sua integração para cobrir todos os cenários tornará mais fácil construir sua integração no Chatlayer.

Perguntas frequentes sobre integração

Aqui você pode encontrar algumas perguntas frequentes sobre nossas opções de integração:

Qual é a diferença entre a API Webhook e a API do Chatlayer?

A API do Chatlayer funciona como formato de requisição e resposta, então uma requisição é enviada ao sistema externo e uma resposta é enviada de volta.

A API Webhook funciona como um sistema de acionamento por evento onde, quando o processamento de determinada requisição é concluído, fazemos uma chamada de API ao seu sistema com os dados que você esperava da chamada anterior.

Quais linguagens vocês suportam no Chatlayer?

Nossos diálogos de ação de código do bot permitem que você execute um script JavaScript durante o fluxo do bot

Vocês têm um arquivo swagger?

Nós temos um arquivo swagger! O conteúdo do arquivo swagger está implantado aqui.