Tempo aproximado para leitura: 00:04:30 min
Dúvida
Como utilizar o Postman para consumir API RM?
Ambiente
Cross Segmentos - Backoffice RM - Integração - Todas as versões.
Solução
O que é o API?
A API (Application Programming Interface) é uma interface de programação de aplicativos usada no desenvolvimento web e de software. Permite que diferentes aplicativos interajam por meio de solicitações e compartilhem dados de forma segura e eficiente. Uma API inclui regras e protocolos que ajudam a usar as funções de um aplicativo dentro do outro.
O que é o Postman?
Postman é uma solução para testes funcionais livre e opensource. O Postman é um aplicativo com a função de testar e desenvolver APIs em uma interface bastante simples e intuitiva. Ele nos permite simular requisições HTTP de forma rápida, armazenando-as para podermos usá-las posteriormente.
Além disso, para cada requisição feita, o Postman analisa as respostas enviadas pela API e as exibe visualmente de forma muito agradável e fácil de entender, reduzindo consideravelmente o tempo necessário para o desenvolvimento e testes de sua aplicação
Site oficial: https://www.postman.com/
Qual relação existe entre o Postman e as APIs RM?
A arquitetura do RM disponibiliza API's do sistema RM para consumo, contribuindo assim em um papel importante no desenvolvimento e na integração de uma aplicação com a outra, auxiliando os desenvolvedores a testar, desenvolver e documentar estas API's de forma eficiente.
O Postman é uma ferramenta versátil que pode ser usada em conjunto com a API do sistema RM para testar, desenvolver integrações, automatizar testes e documentar a API para colaboração entre os membros da equipe.
Lembrando que o Postman não é a ferramenta que fará a integração de sistemas externos com o RM, ele serve apenas como interface para você testar suas solicitações aos serviços disponibilizados pelas APIs do RM.
Como configuro o Postman para funcionar em conjunto as API's do RM?
É preciso inicialmente efetuar algumas configurações para que o Postman comunique corretamente com a API do RM. Para isso, é preciso habilitar os WebServices RM via Host, conforme documentação abaixo:
Como Habilitar Webservice via RM Host
- Configuração para disponibilização de WebService e API:
Com essa configuração realizada, valide se o Swagger do RM na porta utilizada está sendo carregado corretamente. Se o carregamento for realizado com sucesso, o serviço da API já estará disponível para uso.
O que é o Swagger?
GetAll - Retornar todos os usuários do sistema
1. Com o Postman aberto, crie uma nova requisição HTTP:
2. Preencha a URL da API de Usuários a ser utilizada e selecione o Método GET:
GET - http://localhost:8051/api/framework/v1/users
3. Preencha a autorização para realizar o consumo da API, neste campo deve ser utilizada a autenticação Basic ou Bearer Token para o correto acesso.
Segue documentação sobre estes tipos de autenticação:
Como são utilizados as Autenticações Basic e Bearer Token
Para o exemplo, utilizaremos a autorização com o tipo Basic, lembrando que o usuário a ser utilizado como credencial deve possuir permissão de acesso no sistema a esta funcionalidade.
Informe o usuário e sua respectiva senha, os mesmos dados que são utilizados no acesso ao sistema.
4. Com a parametrização para o consumo da API já realizada no Postman, basta realizar o "Send" desta requisição e poderá validar o retorno desta API, no caso, o retorno de usuários do sistema:
Com isso o consumo da API de Usuários e o retorno dos dados foram realizados com sucesso, assim poderá prosseguir com os testes de funcionalidade da API.
Segue abaixo o GIF completo do processo:
Saiba Mais:
Para mais informações, consulte as documentações indicadas neste artigo:
Como Habilitar Webservice via RM Host
Como são utilizados as Autenticações Basic e Bearer Token
O que é o Swagger?
API de Usuários RM
0 Comentários