> For the complete documentation index, see [llms.txt](https://docs.chatlayer.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.chatlayer.ai/chatlayer-documentation-pt-br/integrateandcode/custom-back-end-integrations/integrations-101.md). # Integrações personalizadas 101 Gostaria de começar sua jornada de integração com a Chatlayer? Ótima escolha! Esta página vai te ajudar a começar e te guiar na direção certa. ## Escolha sua integração A Chatlayer oferece várias formas de integração, todas com suas próprias possibilidades. ### plugin de API A integração por API é uma integração que permite fazer chamadas de API para o seu servidor e processar o resultado conforme respondido pelo seu servidor. Você pode encontrar isso em um bloco de Ação > API. Você pode usar melhor a API quando quiser fazer uma chamada de API para o seu servidor para os seguintes casos de uso: * Para criar facilmente uma requisição GET ou POST, preenchendo apenas os headers e parâmetros. * Quando quiser que seu servidor responda a uma mensagem específica. * Quando quiser obter detalhes do seu servidor para serem armazenados na sessão. * Integrar com sua própria API, na qual 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 a Chatlayer espera. O formato que a Chatlayer espera pode ser encontrado [aqui](https://docs.chatlayer.ai/integrations/custom-back-end-integrations#sending-the-api-response). Para mais informações sobre integração por API, visite [esta página](https://docs.chatlayer.ai/bot-answers/dialog-state/action-bot-dialog#api). ### API REST v1 da Chatlayer Nossa própria API REST JSON, conforme descrita em nossa [documentação da API](https://api.chatlayer.ai/v1/docs/), pode ser usada para fazer chamadas de API para a Chatlayer e também como outra forma de integrar seu serviço à Chatlayer. Um dos casos de uso mais comuns da API Chatlayer (REST JSON) seria integrar o canal Webhook. Também oferecemos uma variedade de serviços por meio da nossa API, alguns deles são: * Obter todas as conversas * Obter todas as mensagens em uma conversa * Enviar mensagens * Definir sessão * Pausar/despausar o bot * Disparar um bloco específico do bot * Extrair o NLP de uma expressão * Enviar mensagens de usuários vindas do seu [canal Webhook](https://docs.chatlayer.ai/channels/webhook-api) Ao fazer uma requisição à API da Chatlayer, a Chatlayer espera que um bearer token seja enviado para autorização. No caso de um token não autorizado, respondemos com `401 Unauthorized` código de status. Alguns endpoints têm limite de taxa e isso pode ser identificado verificando os headers conforme definido abaixo: ```http HTTP/1.1 200 OK x-ratelimit-limit: 1200 x-ratelimit-remaining: 1199 x-ratelimit-reset: 1609459200000 ``` * `x-ratelimit-limit` - o limite máximo de taxa aplicável à requisição atual. * `x-ratelimit-remaining` - o número de requisições restantes para a janela atual de limite de taxa. * `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ções podem ser vistos no lado direito da página para cada requisição. Algumas respostas de exemplo também podem ser vistas no canto inferior direito da página. Você pode expandir todo o schema do corpo da requisição para encontrar todos os schemas dos objetos que podem ser enviados como requisição para a API da Chatlayer, conforme mostrado na imagem abaixo, e [nesta página](https://api.chatlayer.ai/v1/docs/#section/Overview). ![](/files/d7b19ca2fe04450f054340389dc6c7ab4c2d7850) ### Editor de Código No editor de código, você pode adicionar facilmente 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 enviada de volta. Esta é uma ferramenta muito versátil que fornecemos e que ajuda você a adicionar lógica personalizada ao bot. Para começar a construir com esta integração, você não precisa de nada além de conhecimento (básico) em JavaScript. Você pode usar melhor o editor de código se quiser: * Lógica personalizada a ser adicionada ao bot, decidindo para onde o fluxo deve seguir em seguida. Isso também pode ser feito com Go Tos, mas o editor de código permite condições mais complexas do que o Go To. * Usar a resposta enviada pelo servidor durante uma chamada de API e querer primeiro analisar os dados enviados pelo servidor antes de processá-los mais. * Integrar com uma API de terceiros, por exemplo [criar um ticket](https://docs.chatlayer.ai/integrations/human-offloading-live-chat/creating-a-zendesk-support-ticket) em um sistema externo de abertura de chamados Para ver alguns exemplos de como usar o editor de código, confira este [POST ](https://docs.chatlayer.ai/integrations/code-action/airtable)ou [GET ](https://docs.chatlayer.ai/integrations/code-action/retrieving-data-from-airtable-get)exemplo. ### canal Webhook O canal Webhook é melhor usado quando você quer utilizar nosso incrível mecanismo de NLP e o fluxo do bot fornecido pela Chatlayer junto com sua própria página personalizada que trata a interface de chat. A integração Webhook também pode ser usada se você quiser integrar um bot na Chatlayer com outro bot que você tenha em execução em outro lugar. O conceito por trás desta integração é que a Chatlayer trabalhará nos bastidores para processar suas consultas e, assim que a consulta for processada, a Chatlayer chamará sua API com o resultado. Isso torna esta integração mais leve e pode ser facilmente integrada a outros canais. Para tarefas de processamento intenso, você não precisa ficar esperando a resposta da Chatlayer, pois chamaremos a URL da sua própria API quando o processamento terminar. Você pode ativar o canal Webhook na página 'Channels' da plataforma. Tudo o que você precisa fazer é fornecer a URL para a qual precisamos fazer a chamada de API quando a solicitação do webhook for processada. Para mais informações sobre o canal Webhook, visite [esta página](https://docs.chatlayer.ai/channels/webhook-api). ## Como começar Agora você escolheu qual tipo de integração é melhor para o seu bot, ótimo! Agora, você precisará começar a mapear como sua integração será. Para toda integração, exceto o canal Webhook, é importante visualizar quais informações você precisa coletar primeiro do usuário antes de enviá-las ao sistema externo. Por exemplo, ao criar um ticket em um sistema externo de chamados, primeiro decida quais variáveis você precisa, como categoria, descrição, endereço de e-mail etc. Depois, certifique-se de que todas essas variáveis sejam enviadas corretamente ao sistema externo de chamados. 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 específica em que a resposta X leva a um bloco diferente na 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 na 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 da Chatlayer? A API da Chatlayer funciona no 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 disparo de eventos em que, 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 idiomas a Chatlayer suporta? Nossos diálogos de ação de código do bot permitem executar um script JavaScript durante o fluxo do bot #### Vocês têm um arquivo Swagger? Temos sim um arquivo Swagger! O conteúdo do arquivo Swagger é implantado [aqui](https://api.chatlayer.ai/v1/docs/#section/Overview). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.chatlayer.ai/chatlayer-documentation-pt-br/integrateandcode/custom-back-end-integrations/integrations-101.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.