> For the complete documentation index, see [llms.txt](https://api-docs.toconline.pt/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-docs.toconline.pt/setup-do-postman.md).

# 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="/files/7g6chbjr9ldg4Wf4gQVs" 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="/files/DjdTO5jsZxcbfw8Dvjfe" 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="/files/jXwxlyEAkEbFYLheAiMW" 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="/files/Q4VM3M4GJ3FjFS487vN4" alt=""><figcaption></figcaption></figure>

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

<figure><img src="/files/OpAuvxXqNAnDrmN7a8u6" 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="/files/zjbHiZ6YMPUX5tSIOFZh" alt=""><figcaption></figcaption></figure>

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"

<figure><img src="/files/b1ANtiKc1jS697yQqX2g" alt=""><figcaption></figcaption></figure>
