Setup do Postman

Esta primeira página descreve o processo de setup e de obtenção das credenciais de acesso à API, para qualquer uma das versões.

Configuração de Acesso à API

Para configurar o acesso à AP, siga os passos abaixo:

1. Acesse o menu Empresa > Dados API. Esta opção está disponível somente para os administradores da empresa.

2. Insira o nome e o e-mail do integrador responsável pela conexão com a API.

Após a conclusão destes passos, o integrador receberá um e-mail contendo:

• Um link temporário para consulta e edição das credenciais de acesso à API.

• Um ficheiro necessário para a utilização com o Postman.

Setup Postman

Após acessar a página de downloads do Postman em https://www.postman.com/downloads/ e concluir a instalação do software, na página inicial, selecione a opção "Importar" para prosseguir.

A partir deste ponto, deverá importar o ficheiro descarregado na página de credenciais da API.

Com este ficheiro importado, deverá ter uma nova coleção aberta, com os possíveis pedidos à API disponibilizados.

Antes de realizar qualquer pedido, é necesário realizar a autenticação. Para o efeito, deve clicar em Open APIDe seguida, deve clicar em "autenticação".

Daqui, deverá ter todos os campos como mostrado na imagem, ir ao final da página e clicar em "Gerar novo token de acesso". Este processo irá abrir uma página no seu browser, que deverá ativar um pop-up. Caso este pop-up não surja, deverá garantir que não tem a opção de 'permitir pop-ups' desativada. Quando o pop-up surjir, deverá clicar na checkbox que surge no popup, antes de confirmar a operação.

Para finalizar, voltar ao início da página, e selecionar o token gerado.

Pedidos à API

A partir deste ponto, todos os passos estão concluidos para a experimentação com a API. De modo a enviar um pedido à API, deve selecionar o pedido que quer enviar, na barra lateral esquerda.

Aberto o pedido, pode editar os parâmetros que deseja enviar, e enviar o pedido utilizando o botão "enviar".

A resposta do pedido irá surgir na caixa "Resposta"