# 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="https://2485700574-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXnBGMr6q45nMdBQT1ioR%2Fuploads%2Fgit-blob-41fffb7bd08570ea01afc313335000f2422ad8e3%2Fimage%20(15).png?alt=media" 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)](https://app.gitbook.com/s/0E9n0hpwK2TzblZSHb8i/manuais-de-telas/cadastros-gerais-de-componentes/cadastro-de-usuario).\
Para instruções detalhadas de geração, acesse a documentação de [Chave de acesso](https://ajuda.consistem.com.br/consistem-api/autenticacao/obter-uma-chave-de-acesso).

### 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="https://2485700574-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXnBGMr6q45nMdBQT1ioR%2Fuploads%2Fgit-blob-abd238a0383051231551e068826af1c22b95eca9%2Fimage%20(17).png?alt=media" 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="https://2485700574-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXnBGMr6q45nMdBQT1ioR%2Fuploads%2Fgit-blob-909fbe0d87e41dfc635f30eff0c01576e32a3b0c%2Fimage%20(18).png?alt=media" alt=""><figcaption></figcaption></figure>

### Analisando a Resposta

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

<figure><img src="https://2485700574-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXnBGMr6q45nMdBQT1ioR%2Fuploads%2Fgit-blob-3bfdac47e5dcf09238224deb87723c3c4f2a3a13%2Fimage%20(20).png?alt=media" 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>