Chamada de API

Desenvolvemos a habilidade Call API para ajudar você a chamar rapidamente uma API em seu fluxo. Você pode salvar e usar as respostas recebidas da API externa no código e nos fluxos do seu chatbot.

Chamar uma API envolve fazer uma solicitação HTTP do Botpress para um host nomeado em um servidor. A requisição visa acessar um recurso no servidor. A seguir estão os componentes de sua solicitação por meio dos quais você fornecerá informações a uma API.

O corpo da solicitação é definido na interface abaixo. Certifique-se de que o corpo da solicitação esteja de acordo com a sintaxe especificada para a API que você está chamando.

Os cabeçalhos de solicitação podem ser definidos aqui e devem respeitar o formato JSON.

Todas as APIs respondem a cada solicitação com um status HTTP indicando se a solicitação foi bem-sucedida. A resposta normalmente vem com uma resposta json que pode conter informações adicionais. 

A habilidade Call API oferece suporte ao recebimento e armazenamento dessa resposta da seguinte maneira.

Usamos memória para salvar a resposta dada pela API que estamos chamando. 

Por padrão, o Botpress salvará a resposta em temp.response, mas é possível usar a memória de sua escolha de acordo com o caso de uso.

O objeto de resposta salvo se parece com isso:

Quando uma resposta retornar um código de status 400 e acima, a solicitação falhará e executará a On failure transição. 

Todos os outros códigos de status resultarão em sucesso e executarão a On success transição.

Botpress suporta modelagem no body e headers para acessar variáveis ​​armazenadas na memória. 

Todos os tipos de memória bot, user, session, temp e event são acessíveis por meio de modelos.