> For the complete documentation index, see [llms.txt](https://ajuda.consistem.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ajuda.consistem.com.br/consistem-api/ambiente/portal-da-api.md).

# Portal da API

O **Consistem ERP** fornece uma interface interativa baseada em Swagger, permitindo a visualização dos endpoints disponíveis e a execução de testes de requisições em tempo real diretamente no seu ambiente.\
\
Para acessar o **Portal da API**, utilize o endereço do seu ambiente seguido de `/api/`:

{% hint style="info" %}
https\://**URL\_ACESSO\_ERP**/api/
{% endhint %}

## Como Testar as APIs

Você pode testar as integrações diretamente através da interface do Swagger instalada no seu servidor do **Consistem ERP.**

<figure><img src="/files/K8DgCuzPRemaGEGNjMnA" alt=""><figcaption><p>Portal da API</p></figcaption></figure>

### Obtenção da chave de acesso (Token)

Utilize a chave gerada através do [Cadastro de Usuário (CSMEN050)](/componentes/manuais-de-telas/cadastros-gerais-de-componentes/cadastro-de-usuario.md).\
Para instruções detalhadas de geração, acesse a documentação de [Chave de acesso](/consistem-api/autenticacao/obter-uma-chave-de-acesso.md).

### Autenticação no Portal

Antes de realizar qualquer teste, é necessário autenticar sua sessão:

1. Clique no botão **Authorize** (cadeado).
2. No campo `Value`, informe o **token** gerado anteriormente.
3. Clique novamente em **Authorize** e, em seguida, em **Close**.

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

### Executando uma Requisição

Com a sessão autenticada, você pode simular chamadas reais:

1. Selecione o grupo e o serviço desejado (Ex: `Cadastros Gerais` -> `GET /empresa/id`).
2. Clique no botão **Try it out** para habilitar a edição.
3. Preencha os parâmetros solicitados (campos marcados com `*` são obrigatórios).
4. Clique no botão **Execute**.

<figure><img src="/files/2bSQMRPvnUnRR30la3lS" alt=""><figcaption></figcaption></figure>

### Analisando a Resposta

Logo abaixo, a interface exibirá o **Response body** (dados retornados) e o **Code** ([status da resposta,](/consistem-api/guias-tecnicos/codigos-de-status-das-respostas.md) ex: 200, 404, 500).

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

{% hint style="info" %}
**Nota**\
As APIs seguem padrões de mercado e podem ser executadas em qualquer ferramenta externa de sua preferência, como o Postman ou Insomnia.
{% endhint %}

<p align="center">Esse conteúdo foi útil?</p>

<p align="center"><a href="https://movidesk.consistem.com.br/form/10395/" class="button primary" data-icon="thumbs-up">Sim</a> <a href="https://movidesk.consistem.com.br/form/10395/" class="button primary" data-icon="thumbs-down">Não</a></p>


---

# 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 dynamically by asking a question.

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

```
GET https://ajuda.consistem.com.br/consistem-api/ambiente/portal-da-api.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.