Utilizar o Postman para testar a WebAPI

O Postman é uma ferramenta que permite testar serviços REST (Web APIs) através de uma interface intuitiva. Para além do envio de pedidos HTTP, esta ferramenta analisa as respostas, apresentando-as de forma simples e fácil de entender.

Coleção PRIMAVERA ERP 10

Começar a usar o Postman

1. Faça o download e instale a aplicação Postman https://www.getpostman.com;
2. Carregue no botão Run in Postman;
3. Selecione o ambiente de trabalho;
4. Altere o valor das variáveis de ambiente de acordo com a sua instalação;
5. Selecione na árvore o elemento Token e depois Token Request;
6. Carregue em Send. A resposta será apresentada no Tab Body. Neste caso, é devolvida a autorização necessária para que possa efetuar os pedidos seguintes à Web API.

Pedido do token

O pedido do Token tem de ser, obrigatoriamente, o primeiro pedido a efetuar quando a Web API é utilizada. Este permite aos clientes obter uma autorização que lhes vai permitir realizar as operações necessárias. No caso do ERP PRIMAVERA, existem duas situações onde este pedido pode utilizar parâmetros diferentes, de acordo com o endpoint que se pretende consumir. Por exemplo, para obter uma lista de empresas, não é necessário indicar a empresa, logo este parâmetro pode ser omitido e o sistema vai devolver a autorização pedida. No entanto, se este Token for usado para aceder a outro recurso dependente da empresa, o sistema vai devolver um erro por falta de autorização.

Variáveis de ambiente

Estas variáveis são um recurso muito importante quando se trabalha com várias Collections no postman. Para evitar estar sempre a escrever os mesmos parâmetros nos vários requests, podemos criar variáveis de ambiente e atribuir-lhes o respetivo valor.  Neste sentido, na Collection do ERP, existe um ambiente "ERPERP10-Env-Variables" onde estão todas todas as variáveis utilizadas. Para usar esta Collection deve modificar as respetivas variáveis de acordo com a sua realidade.

• ApiUrl: URL da Web API, tipicamente http://localhost:2018/WebApi/.
• Username: nome do utilizador utilizado do ERP.
• Password: palavra-passe do utilizador do ERP.
• Company: código da empresa.
• Instance: instância do ERP, tipicamente "Default".
• GrandType: tipo de autenticação utilizada pelo framework OAuth 2. Neste caso será sempre "password".
• FirstToken/SecondToken: variáveis utilizadas pela PRIMAVERA.
• Line: linha do produto: "LP" ou "LE"