Skip to content
English
Ir a www.atomchat.io
  • There are no suggestions because the search field is empty.

Aprenda a testar sua API no POSTMAN e configurá-la nas requisições HTTP da Atom

Neste artigo, veremos em passos simples um caso de uso no qual uma API se conecta a ATOM e as configurações necessárias para esse caso de uso, utilizando o POSTMAN e o componente Requisição HTTP da Atom. Vamos começar!

Caso de uso

Uma empresa utiliza um sistema interno que registra seus clientes por meio de um campo chamado ID ou identificador. Esse ID é único para cada cliente e permite realizar solicitações específicas de informações. Para isso, o cliente deverá fazer login com seu usuário e senha, que serão enviados por e-mail.

Com esse ID e por meio do componente “Requisição HTTP” da Atom, ambos os sistemas serão conectados para solicitar dados adicionais do cliente, como, por exemplo, quando ele deseja saber seu saldo pendente ou a data da sua próxima fatura.

Quando o cliente interage com um bot e solicita essas informações, após o login correspondente por parte do cliente, a Atom envia uma consulta ao sistema interno utilizando o componente Requisição HTTP, fazendo uso desse campo ID.

Esses dados são retornados pelo sistema interno a Atom e armazenados na seção Salvar Resposta do componente HTTP da plataforma. Dessa forma, a informação solicitada fica automaticamente disponível e atualizada para que, caso a conversa seja transferida para um agente, ele possa visualizar os dados completos do cliente sem a necessidade de realizar uma nova solicitação.

É importante destacar que, para que essa integração funcione corretamente, é necessário primeiro verificar se a autenticação da API do sistema interno está configurada e funcionando adequadamente.

Para isso, utiliza-se o POSTMAN, onde é possível validar o acesso e testar as requisições à API. Uma vez verificado que a autenticação foi bem-sucedida, a mesma autenticação é configurada no componente “Requisição HTTP” da Atom, permitindo que o fluxo de informações seja contínuo e sem interrupções.

A Atom suporta apenas APIs que utilizem o formato de dados JSON para envio e recebimento de informações.

Se a documentação de um sistema externo apresentar exemplos em outros formatos, como XML ou CSV, será necessário realizar uma conversão prévia para JSON antes de integrá-lo a Atom.

Teste de conexão com Postman

Antes de configurar a requisição HTTP, podemos realizar um teste para verificar se a autenticação com nossa API está correta.

Para isso, realizaremos no Postman um teste de Basic Authentication. Para esse teste, é necessário ter o nome de usuário e a senha de acesso da API.

Basic <Base64 encoded username and password>

Se você deseja saber mais sobre os diferentes tipos de autenticação no POSTMAN, leia o artigo correspondente na base de conhecimento.

Para realizar o teste de autenticação, acesse o POSTMAN.

Em New Request, utilizaremos o método GET, informaremos a URL da nossa API e, na seção Authorization, selecionaremos Basic Auth, inserindo o usuário e a senha correspondentes. Em seguida, clicamos em Send para testar.

Uma vez que a conexão seja bem-sucedida, você visualizará o código 200 OK, conforme exibido na tela, o que significa que a conexão foi realizada com sucesso.

Na aba BODY, procure pela seção Authorization e localize o token que foi gerado, que aparece entre aspas após os dois pontos na mesma linha. Esse token será utilizado posteriormente para configurar os cabeçalhos do componente Requisição HTTP, onde Authorization será a nossa Key e, neste caso,

Basic cG9zdG1hbjpwYXNzd29yZA== será o token utilizado no cabeçalho dessa conexão.

Configuração na Requisição HTTP

Preenchemos os campos correspondentes na requisição HTTP conforme veremos a seguir.

Dentro do nosso bot, acessamos o componente Requisição HTTP, clicando duas vezes para visualizar os campos na barra lateral direita da tela.

Aqui realizaremos as seguintes configurações:

  • Utilizaremos o método POST e informaremos a URL da API à qual iremos nos conectar.

No corpo da requisição, detalharemos os campos que serão enviados à API com o ID do nosso cliente.

Como cabeçalhos, utilizaremos a Key e o Token correspondentes, conforme descrito no passo anterior.

Importante

Leve em consideração que, no Postman, a autenticação é configurada como Basic Authentication, especificando usuário e senha. No entanto, no componente HTTP da Atom, no Header, é possível especificar apenas um token.

Esse token pode ser gerado pelo próprio Postman ou por meio de um gerador de chaves, como por exemplo:

https://www.debugbear.com/basic-auth-header-generator

Em seguida, em Salvar Resposta, considerando que nosso cliente deseja saber o saldo pendente, salvaremos nos campos de informação SALDOPENDIENTE e FECHA_PAGO_SALDO os dados provenientes da API, especificamente das variáveis data.adeudo e data.fecha_limite.