-Possíveis erros:
Para realizar sua integração com sucesso é preciso se atentar a alguns pontos importantes na realização de sua integração que são os seguintes:
Erro de servidor e suas possíveis causas: O Erro de servidor geralmente é causado por uma resposta inválida de API, alguns problemas comuns são
1. Sua requisição contém campos incorretos logo a resposta API não retorna válida
2. Sua requisição retorna um status de erro que não pode ser exibida como JSON Válido
3. A API pretendida não está retornando uma resposta JSON
4. Clicar em "Testar requisição" com um campo personalizado na URL
Para verificar com clareza os possíveis problemas relacionados a resposta API você pode realizar um teste de sua aplicação utilizando o POSTMAN, que é uma ferramenta para testar e depurar integrações API 's.
-Erros de mapeamento:
Para executar um mapeamento de resposta bem sucedido, é preciso se atentar aos tipos de campos que irá utilizar no mapeamento. Para ser bem sucedida, siga as instruções:
1. Evite utilizar campos que não sejam do tipo texto de maneira incorreta: Atualmente no BotConversa possuímos 4 tipos de campos, sendo eles:
- Texto: Este campo aceita todo tipo de valor e formato. Aceitando caracteres especiais, números, textos, etc... Recomendamos-vos para que assim possa garantir um bom mapeamento em suas requisições e com isso não causar divergência de formato de campos em seu mapeamento.
- Número: Este campo aceita apenas números e pontuações como, ponto (.) e vírgula (,). Outros tipos de caracteres não são aceitos neste campo.
- Data: Este campo apenas aceita data em um formato específico no qual seria (dd.mm.YYYY).
- Data & Hora: Este campo seria para armazenar apenas data e hora, sendo assim, conforme mostrado anteriormente, ele apenas aceitará datas no formato (dd.mm.YYYY HH:MM:SS).
💡 Caso a resposta retornada pela API não esteja no formato aceito pelo campo ele pode causar uma falha no mapeamento, resultando assim no não envio da resposta.
Ex: Mapear em um campo do tipo Data, uma resposta vinda como "30/08/2024".
Isso causará erro, pois, o campo de data do BotConversa não reconhece este tipo de formato como formato válido
2- Certifique-se que o mapeamento do campo de resposta está correto, percorrendo assim o caminho da resposta
Aqui, queremos capturar a resposta que a API nos retornou, e, ela se encontra na parte de "Content" que se localiza dentro do parâmetro "Choices"
Seguindo este caminho podemos fazer o mapeamento da seguinte maneira:
choices[0].message.content
Utilizo [] para mostrar à API que eu quero puxar o parâmetro 0, é nele que se localiza o caminho
Os pontos (.) utilizo para dizer à minha API que desejo estar buscando um objeto, quero seria o próximo passo
Com isso, consigo efetuar o mapeamento para que minha API possa identificar onde desejo buscar a resposta.
💡 O "root" é apenas uma maneira do BotConversa exibir o início da API.
O root NÃO conta como mapeamento, sendo assim, basta ignorá-lo
Neste caso se desejamos buscar o CEP, basta fazer o mapeamento como:
cep
-Headers
Geralmente alguns erros de APIs se localizam no Headers da requisição que estamos tentando executar. Alguns deles são:
1. API PHP: Quando se possui uma API na qual está sendo efetuada no PHP é necessário com que insira uma forma de mapeamento no headers
Envie a seguinte informação no header do bloco de integração:
User-Agent:
Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36
Geralmente essa informação deve ser enviada em casos onde o link da requisição é em php.
2- Autenticação incorreta: Algumas APIs como a API da OpenAI, exige com que seja inserido à frete da chave API, uma autenticação "Bearer"
💡 Recomendamos sempre verificar na documentação API na qual está utilizando para inserir o Headers de maneira correta, e, assim fazer com que a integração seja bem sucedida