# Setup do Postman

#### 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.

<figure><img src="https://1863668386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fk7sif7BY0rPzivMcj1HB%2Fuploads%2Fl2NS4hxLu1BnVFOrwVMo%2FClicar%20em%20import.png?alt=media&#x26;token=75ee7a58-5c51-4196-99e7-718f422a56c7" alt=""><figcaption></figcaption></figure>

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.

<figure><img src="https://1863668386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fk7sif7BY0rPzivMcj1HB%2Fuploads%2F1HWhhiHdCPH4RBj7zczb%2FFicheiro%20importado.png?alt=media&#x26;token=bedf14ad-f0b3-4d37-9733-38f6d58ee14a" alt=""><figcaption></figcaption></figure>

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".

<figure><img src="https://1863668386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fk7sif7BY0rPzivMcj1HB%2Fuploads%2FQrhKfJsMQbdiYwSh0GmE%2FClicado%20em%20Authorization.png?alt=media&#x26;token=0e783ea2-d443-40f5-b0fc-42773177855b" alt=""><figcaption></figcaption></figure>

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.

<figure><img src="https://1863668386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fk7sif7BY0rPzivMcj1HB%2Fuploads%2FAhUF1UL0QTTca4issk36%2FClicar%20em%20get%20access%20token.png?alt=media&#x26;token=41362950-2852-46af-824b-82739439f0df" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://1863668386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fk7sif7BY0rPzivMcj1HB%2Fuploads%2Fn6Bfx16RuJbpXuYgVMtJ%2FSelecionar%20o%20Token%20Gerado.png?alt=media&#x26;token=55e14dd6-17b0-4a7a-af83-ba2f6db0da66" alt=""><figcaption></figcaption></figure>

**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.

<figure><img src="https://1863668386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fk7sif7BY0rPzivMcj1HB%2Fuploads%2FjJVI1ubwG3vK4Q4Jrypl%2FSelecionar%20a%20barra%20lateral%20esquerda.png?alt=media&#x26;token=6401d8b4-4dfb-4c9f-ad99-f5df2d5b80c3" alt=""><figcaption></figcaption></figure>

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

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

<figure><img src="https://1863668386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fk7sif7BY0rPzivMcj1HB%2Fuploads%2FmrJygqqRZgr56V5iAzSG%2FClicar%20em%20Send.png?alt=media&#x26;token=59284010-492f-4edd-b92d-42914d953bf8" alt=""><figcaption></figcaption></figure>