# Como acessar o Swagger / OpenAPI

{% hint style="info" %}
Atenção: os recursos dessa página são opcionais. Você não precisa conhecer ou utilizar essas tecnologias para consumir as API's do Zeev
{% endhint %}

## O que é o Swagger ?

Swagger é uma ferramenta que ajuda desenvolvedores a trabalhar com APIs.

No Zeev, o Swagger mostra todas as APIs disponíveis e como usá-las para fazer coisas como criar novas tarefas, ver o status de alguma atividade, e muito mais.

### Como acessar a interface do swagger no Zeev ?

O Zeev tem uma interface do Swagger. Esta interface está disponível no endereço `https://seu.dominio.do.zeev/api/docs/index`.

Aqui, "seu.dominio.do.zeev" deve ser substituído pelo endereço específico do Zeev que você usa. Ao acessar essa URL, você verá uma lista de todos os endpoints disponíveis, como no exemplo abaixo:\
![](/files/k9ms7rJPlFc8UlBomhRB)

## O que é o OpenAPI.json?

O OpenAPI.json é como um manual detalhado de instruções para uma API. Ele segue um padrão específico que torna fácil entender e usar a API. Aqui estão os pontos principais:

1. **Descrição da API**: Ele lista todas as funções da API, como os diferentes URLs que você pode acessar e os tipos de dados que você pode enviar e receber.
2. **Facilita Integrações**: Ferramentas como Postman ou Insomnia podem ler este arquivo para ajudar você a testar e usar a API sem complicações.
3. **Padrão de Documentação**: Ele segue um formato comum que é fácil de entender se você já conhece o padrão.
4. **Automação e Geração de Código**: Ferramentas podem usar este arquivo para criar automaticamente partes do seu código, poupando tempo e evitando erros.

### Como acessar o documento OpenAPI.json?

Você pode acessar o arquivo OpenAPI.json através da URL `https://seu.dominio.do.zeev/api/2/docs/`, onde "seu.dominio.do.zeev" é o endereço base que você usa para acessar o Zeev. Basta substituir "seu.dominio.do.zeev" pelo seu endereço específico.

Depois de acessar essa URL, você pode importar o arquivo em ferramentas como Postman ou Insomnia para facilitar os testes e o desenvolvimento de integrações.


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://kb.stoque.com.br/zeev/apis/como-utilizar-as-apis-do-zeev/como-acessar-o-swagger-openapi.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.