> For the complete documentation index, see [llms.txt](https://kb.stoque.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kb.stoque.com.br/zeev/apis/como-utilizar-as-apis-do-zeev/como-testar-o-funcionamento-de-apis/como-configurar-o-postman-para-testar-as-apis-do-zeev.md).

# Como configurar o Postman para testar as API's do Zeev?

## Como importar a coleção do Zeev no Postman?

Para realizar testes das API's zeev com o Postman, é possível importar os dados de OpenAPI exportados automaticamente pelo zeev no seu ambiente.\
\
Existem algumas práticas que vão ajuda-lo a obter a documentação do Zeev no seu Postman de forma mais organizada oferecendo um melhor proveito.\
Para isso siga os passos abaixo:

1. **Obtenha o Postman:** Instale o [**Postman** ](https://www.postman.com/)ou obtenha uma conta gratuita para uso online. Neste tutorial vamos utilizar a versão Desktop Instalada em um computador windows;
2. **Obtenha uma conta no Postman:** No primeiro acesso será solicitado a criação de uma conta gratuita no Postman. Você deve cria-la ou apenas autenticar-se se já for um usuário cadastrado. <br>

   <figure><img src="https://3371003943-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MD66pBdRalAQgnhNstG%2Fuploads%2FmxpCvwOiL0XUU6fcUWA9%2Fimage.png?alt=media&amp;token=33cbd060-ad02-4287-b36e-4dc0553eee2f" alt="" width="459"><figcaption></figcaption></figure>
3. **Importe a coleção do Zeev:** Clique em import<br>

   <figure><img src="https://3371003943-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MD66pBdRalAQgnhNstG%2Fuploads%2FNlXvx9qM040K3O7nUVsx%2Fimage.png?alt=media&amp;token=1238a4ed-cd1b-4e4d-a7e4-76f3dbd689e3" alt="" width="563"><figcaption></figcaption></figure>
4. **Informar a origem da documentação:** Na nova janela que surgir, informe o endereço <https://seu\\_dominio.do.zeev/api/2/docs>, informe no lugar de seu\_dominio.do.zeev o endereço que você utilizada para acessar o Zeev. Ou se preferir, faça download do [#modelo-para-download-do-zeev-openapi](#modelo-para-download-do-zeev-openapi "mention") e importe no seu ambiente:
5. **Configure a importação:** Após informar o endereço do OpenAPI.json ou importar o modelo disponibilizado, cliente em view import settings na janela que surgir, e altere o parâmetro "**folder organization**" de **paths** para **tags**, depois volte e clique em impor&#x74;**:**\ <br>

   <figure><img src="https://3371003943-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MD66pBdRalAQgnhNstG%2Fuploads%2FpuMIOOJ1tTQI4GCFhkKX%2Fimage.png?alt=media&amp;token=8b766fe7-680f-46a1-9e1d-45c50ce8bcc0" alt=""><figcaption></figcaption></figure>

   <figure><img src="https://3371003943-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MD66pBdRalAQgnhNstG%2Fuploads%2FIPMmN7SXk7eWsZ92ZFQs%2Fimage.png?alt=media&amp;token=9137752a-057e-4d63-8b1c-4741878864fb" alt=""><figcaption></figcaption></figure>
6. **Configure o seu endereço:** Se você importou o modelo desta página, clique nos três pontos a frente da pasta criada para a coleção, depois clique em varáveis e informe o seu endereço do Zeev:<br>

   <figure><img src="https://3371003943-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MD66pBdRalAQgnhNstG%2Fuploads%2FtXUywpEComvpZsI0OHiT%2Fimage.png?alt=media&amp;token=bc6e64c9-674e-4f97-b28e-efce731ad501" alt=""><figcaption></figcaption></figure>
7. **Configure a autenticação em nível global:** Ainda na pasta da coleção, clique na guia Authorization, troque Auth Type para Bearer Token, e informe um [token ](https://kb.stoque.com.br/zeev/apis/como-utilizar-as-apis-do-zeev/como-gerar-tokens-para-autenticar-nas-apis.md)válido de usuário do Zeev e clique em salvar.\
   Com esta configuração, os endpoints "herdam" a autorização e você não vai precisar inclui-las manualmente em todas as chamadas.\ <br>

   <figure><img src="https://3371003943-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MD66pBdRalAQgnhNstG%2Fuploads%2F0HpP8lb2ElVKjta95WZA%2Fimage.png?alt=media&amp;token=2fcce2d8-d69f-4ee5-88a5-e476b03bdeb4" alt=""><figcaption></figcaption></figure>

## Modelo para download do Zeev OpenAPI

{% file src="/files/DYIxvabeLXa2mL6uE2si" %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://kb.stoque.com.br/zeev/apis/como-utilizar-as-apis-do-zeev/como-testar-o-funcionamento-de-apis/como-configurar-o-postman-para-testar-as-apis-do-zeev.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
