Aprenda a testar sua API no POSTMAN e configurá-las nas requisições HTTP do Atom
Neste artigo, veremos em passos simples um caso de uso onde uma API se conecta com o ATOM e as configurações para este caso de uso, utilizando o POSTMAN e o componente de Requisição HTTP no Atom. Vamos começar!
Caso de uso:
Uma empresa utiliza um sistema interno que registra seus clientes mediante um campo chamado ID ou identificador. Este ID é único para cada cliente e permite realizar solicitações específicas de informação. Para isso o cliente deverá logar-se com seu usuário e senha que será fornecida por e-mail. Contando com este ID, e através do componente "Requisição HTTP" do Atom, ambos os sistemas se conectarão para solicitar os dados adicionais necessários do cliente, como por exemplo, quando este deseja saber seu saldo pendente ou a data de sua próxima fatura.
Quando o cliente interage com um bot e solicita esta informação, logo após o login correspondente por parte do cliente, o Atom envia uma consulta ao sistema interno usando o componente Requisição HTTP utilizando este campo ID. Estes dados são devolvidos pelo sistema interno ao Atom e, estes campos são armazenados na seção de Salvar Resposta do componente HTTP da plataforma. Desta forma, a informação solicitada fica automaticamente disponível e atualizada para que, se a conversa escalar para um agente, este possa ver os detalhes completos do cliente sem necessidade de fazer uma nova solicitação.
É importante destacar que, para que esta integração funcione corretamente, primeiro é necessário comprovar que a autenticação à API do sistema interno esteja configurada e funcionando adequadamente. Para isso, utiliza-se o POSTMAN, onde se pode validar o acesso e testar as requisições à API. Uma vez verificado que a autenticação é exitosa, configura-se a mesma autenticação no componente "Requisição HTTP" do Atom, permitindo que o fluxo de informação seja contínuo e sem interrupções.
Teste de conexão com Postman
Previamente à configuração da requisição HTTP, podemos realizar um teste para verificar se a autenticação com nossa API está correta.
Para isto realizaremos no Postman um teste de Basic Authentication. Para isto você precisa contar com o nome de usuário e senha de acesso da API.
Basic
Se você deseja saber mais sobre distintos tipos de autenticação no POSTMAN, leia o seguinte artigo
Para fazer o teste de autenticação, então nos dirigimos ao POSTMAN
Ali em New Request, utilizaremos o Método GET, escreveremos a URL de nossa API, e na seção Authorization, selecionamos neste caso Basic Auth e colocamos o acesso com usuário e senha correspondente. Clicamos em Send para testar:
Uma vez que a conexão foi exitosa, você visualizará o código 200 OK, como se mostra na tela, o que significa que a conexão foi exitosa, e na aba BODY, busca a seção de Authorization e o token que foi gerado que se encontra entre aspas logo após os dois pontos da mesma linha. Isso te servirá mais adiante para configurar os cabeçalhos de nosso componente requisição HTTP, ondeAuthorizationserá nossa Key e neste casoBasic cG9zdG1hbjpwYXNzd29yZA==será nosso token para o cabeçalho desta conexão.
Configuração em Requisição HTTP
Preenchemos os campos correspondentes na requisição HTTP como veremos a seguir. Dentro de nosso bot acessamos o componente Requisição HTTP, fazendo duplo clique para acessar os campos na barra lateral direita de nossa tela.
Aqui realizaremos as seguintes configurações:
Utilizaremos o método POST e colocaremos a URL da API à qual nos conectaremos
No corpo detalharemos os campos que enviaremos à API com o ID de nosso cliente:
Como cabeçalhos, utilizaremos um Key e Token correspondentes, o qual se descreveu no passo anterior.
Importante: Tenha em conta que, no Postman se configura em Basic Authentication, e se especifica usuário e senha, mas desde o componente HTTP, no Header, somente é possível especificar um token. Este Token pode ser gerado desde o Postman ou bem desde um gerador de chaves tal como:https://www.debugbear.com/basic-auth-header-generator
Logo emGuardar respuestapor exemplo, dado que nosso cliente queria saber o saldo pendente, guardaremos nos campos de informação SALDOPENDENTE e DATAPAGAMENTOSALDO, a informação que provém da API das variáveis data.adeudo e data.fecha_limite