APIs REST são usadas para Enviar / Receber dados de / para sistemas de terceiros. Usando o bloco de ação de Chamada de Serviço, você pode integrar diretamente a API REST de um sistema de terceiros em um fluxo.

Você pode integrar APIs REST do tipo GET, POST ou PUT através do bloco de ação de Chamada de Serviço na página
Construtor de Bots.

Aqui estão os passos que você pode seguir para configurar o mesmo:

  1. Adicione o bloco de ação 'Chamada de Serviço'.

  2. Configure sua API no painel direito.

    Para configurar sua API no bloco de ação de Requisição HTTP, abaixo estão os campos que você preencherá. Se você é um desenvolvedor, você se sentirá em casa aqui; para outros, pode ser necessário consultar a documentação das APIs para encontrar o que preencher no painel direito.

  3. Tipos de Métodos:

    Primeiro, você precisará selecionar o 'Tipo de Método' na lista suspensa das opções disponíveis. O Reply CX atualmente suporta três tipos de métodos, que são:

    • GET

    • POST

    • PUT

  4. URL do Endpoint:

    Você precisará fornecer a URL absoluta, ou seja, começando com HTTP ou HTTPS. Você também pode usar variáveis na URL digitando '#' já que algumas APIs não possuem cabeçalhos e tudo é mencionado na própria URL.

    For example: https://api.weatherapi.com/v1/current.json?
key=e943b863ebed4572b55140350200312&q=#city#city#.

In the above link, #city# is the variable that has been used.
TypeScript

    1. Cabeçalhos:

      'Cabeçalhos de Requisição' permite autenticar a API com base em seus tokens. Você também pode usar variáveis como tokens digitando '#'.

      Você precisa garantir que adicione o seguinte token no cabeçalho:

    2. Corpo:

      Em 'Corpo da Requisição' você pode definir quais informações precisam ser enviadas ou recuperadas ao chamar a API. Existem duas maneiras pelas quais as informações podem ser enviadas ou recuperadas:

      • Raw (Bruto): É o formato JSON normal no qual a requisição precisa ser passada.

        {     
          "User_name": "Travis",
          "City": "Denver"
}
TypeScript

      • Form (Formulário): Usado para mapear os campos. Você pode fornecer um valor estático ou mapear com as variáveis.

        The values can be mapped in following way:
 
Key1: User_name
Value/Variable1: Travis / #name#
 

Key 2: City
Value/Variable: Denver / #City#
TypeScript

  5. Resposta:

    Você pode armazenar as respostas recebidas da API em variáveis que podem ser usadas posteriormente no fluxo do bot ou na mensagem do bot. O ReplyCX segue o padrão de ponto para armazenar as respostas nas variáveis. Abaixo estão algumas das maneiras pelas quais o caminho pode ser definido.

    Object path for storing the response into variable where list is returned
result.data.list[0].’variable name’
Here the ‘variable name’ is name of variable where the response will be stored.


Object path for storing the response into variable where single value is returned
result.data.’variable name’
Here the ‘variable name’ is name of variable where the response will be stored.
TypeScript

Testando a Integração:

Você pode testar a API dentro do próprio bloco, bem como definir variáveis e armazenar as respostas nelas.

  1. Clique no botão 'Testar a API'.

  2. Forneça a entrada na variável (opcional).

  3. Clique em 'Testar a API' novamente para verificar os resultados.

Armazenando as Respostas:

  1. Clique no 'Ícone de Expandir' para expandir os resultados.

  2. Clique no sinal '+' ao lado do campo para armazenar o valor na variável.

  3. Defina a variável em 'Salvar o campo nesta variável'.

Was this helpful?