> ## Documentation Index
> Fetch the complete documentation index at: https://docs.procfy.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Postman

## **Introdução**

O Postman é uma ferramenta que permite testar e documentar APIs. Com o Postman, você pode enviar solicitações HTTP para o servidor e visualizar as respostas. O Postman também permite criar coleções de solicitações, que podem ser compartilhadas com outras pessoas.

Para começar a usar o Postman, você precisa criar uma conta no site [postman.com](http://postman.com). Após criar uma conta, você pode baixar o aplicativo Postman e fazer login com suas credenciais.

***

## **Importando Coleção no Postman**

Você pode acessar a coleção da API do Procfy no Postman clicando no botão abaixo:

<a href="https://www.postman.com/procfy-io/procfy" target="_blank">
  <img src="https://mintcdn.com/procfy/DyyXpfSyY-_cPB0f/images/button.png?fit=max&auto=format&n=DyyXpfSyY-_cPB0f&q=85&s=46fc19c125cebc21d9bb6168d92f5692" alt="Run Postman" noZoom width="137" height="41" data-path="images/button.png" />
</a>

#### **Importando a coleção**

Para importar a coleção no Postman, siga os passos abaixo:

1. Clique no botão **Run in Postman** e depois em **Fork Collection**.

<Frame>
  <img src="https://mintcdn.com/procfy/DyyXpfSyY-_cPB0f/images/click_collection-118f8ce1.png?fit=max&auto=format&n=DyyXpfSyY-_cPB0f&q=85&s=8ec28e7dc20e843aa72181843a404261" alt="Fork Collection" width="511" height="484" data-path="images/click_collection-118f8ce1.png" />
</Frame>

2. Faça login no Postman, se necessário.

<Frame>
  <img src="https://mintcdn.com/procfy/DyyXpfSyY-_cPB0f/images/login_postman-db2fd2ed.png?fit=max&auto=format&n=DyyXpfSyY-_cPB0f&q=85&s=eddf545e300db787b81dc91705a83e65" alt="Login Postman" width="488" height="673" data-path="images/login_postman-db2fd2ed.png" />
</Frame>

3. Clique no botão **Fork collection** para importar a coleção.

<Frame>
  <img src="https://mintcdn.com/procfy/DyyXpfSyY-_cPB0f/images/confirm_fork-7f9c9dc3.png?fit=max&auto=format&n=DyyXpfSyY-_cPB0f&q=85&s=890b5f5d11f17b5803398067bb91ce21" alt="Confirm Fork" width="530" height="490" data-path="images/confirm_fork-7f9c9dc3.png" />
</Frame>

4. Após importar a coleção, você verá a coleção **Procfy API** no menu lateral esquerdo.

<Frame>
  <img src="https://mintcdn.com/procfy/DyyXpfSyY-_cPB0f/images/collection-c30fa800.png?fit=max&auto=format&n=DyyXpfSyY-_cPB0f&q=85&s=a7b51e80b00d9bc7b39b56e014486ecc" alt="Collection" width="1838" height="573" data-path="images/collection-c30fa800.png" />
</Frame>

***

## **Configurando o ambiente**

Para configurar as variáveis de ambiente no Postman, siga os passos abaixo:

1. Clique no Procfy API no menu lateral esquerdo.

<Frame>
  <img src="https://mintcdn.com/procfy/DyyXpfSyY-_cPB0f/images/click_collection-e0d3c9af.png?fit=max&auto=format&n=DyyXpfSyY-_cPB0f&q=85&s=d72b155714a8166df15ccb449234f431" alt="Click Collection" width="294" height="245" data-path="images/click_collection-e0d3c9af.png" />
</Frame>

2. Clique na aba **Authorization**.

<Frame>
  <img src="https://mintcdn.com/procfy/DyyXpfSyY-_cPB0f/images/click_authorization-85cf98df-2.png?fit=max&auto=format&n=DyyXpfSyY-_cPB0f&q=85&s=98169afaf328fe946d5cfcabb4ff2905" alt="Click Authorization" width="1833" height="486" data-path="images/click_authorization-85cf98df-2.png" />
</Frame>

3. No campo **Bearer Token**, insira a chave de API, que pode ser obtida no painel api tokens, veja como criar uma chave de API [aqui](/sobre-a-nossa-api).

<Frame>
  <img src="https://mintcdn.com/procfy/DyyXpfSyY-_cPB0f/images/insert_token-1eb12137.png?fit=max&auto=format&n=DyyXpfSyY-_cPB0f&q=85&s=5d9fd8c27e72fae798c879c85c376bce" alt="Insert Token" width="974" height="447" data-path="images/insert_token-1eb12137.png" />
</Frame>

***

## **Testando a API com o Postman**

O Postman é uma ferramenta que permite testar e documentar APIs. Com o Postman, você pode enviar solicitações HTTP para o servidor e visualizar as respostas. Para testar a API do Procfy no Postman, siga os passos abaixo:

1. Selecione o que deseja testar no menu lateral esquerdo.

<Frame>
  <img src="https://mintcdn.com/procfy/DyyXpfSyY-_cPB0f/images/click_collection-e2186b18.png?fit=max&auto=format&n=DyyXpfSyY-_cPB0f&q=85&s=c630978d3fdbd6674d99d11e3136e5d0" alt="Click Collection" width="297" height="202" data-path="images/click_collection-e2186b18.png" />
</Frame>

2. Após selecionar o que deseja testar, visualize as solicitações disponíveis.

<Frame>
  <img src="https://mintcdn.com/procfy/DyyXpfSyY-_cPB0f/images/requests-d56ac11f.png?fit=max&auto=format&n=DyyXpfSyY-_cPB0f&q=85&s=effbb82d172d844bd76a855733a3244a" alt="Requests" width="297" height="403" data-path="images/requests-d56ac11f.png" />
</Frame>

3. Selecione a solicitação que deseja testar.

<Frame>
  <img src="https://mintcdn.com/procfy/DyyXpfSyY-_cPB0f/images/click_request-83344eb4.png?fit=max&auto=format&n=DyyXpfSyY-_cPB0f&q=85&s=1d59303cfe7d080c8ba5f486ad102fc3" alt="Click Request" width="1870" height="463" data-path="images/click_request-83344eb4.png" />
</Frame>

4. Clique no botão **Send** para enviar a solicitação.

<Frame>
  <img src="https://mintcdn.com/procfy/DyyXpfSyY-_cPB0f/images/send_request-677c4e73.png?fit=max&auto=format&n=DyyXpfSyY-_cPB0f&q=85&s=f3a895474f7833dab088cd25c0a505e2" alt="Send Request 677c4e73" width="1488" height="457" data-path="images/send_request-677c4e73.png" />
</Frame>

5. Visualize a resposta da solicitação.

<Frame>
  <img src="https://mintcdn.com/procfy/DyyXpfSyY-_cPB0f/images/response-c2486204-(1).png?fit=max&auto=format&n=DyyXpfSyY-_cPB0f&q=85&s=f229fc180d18526d3f02ddf20cece3ce" alt="Response" width="1486" height="964" data-path="images/response-c2486204-(1).png" />
</Frame>

6. **Pronto!** Agora você pode testar a API do Procfy no Postman.