> 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/readme.md).

# Consistem API

Interoperabilidade segura entre módulos e aplicações de terceiros.

A **Consistem** desenvolveu APIs próprias para viabilizar e gerenciar a integração entre seus módulos e softwares de terceiros de forma segura.

### O que é uma API?

A sigla API significa *Application Programming Interface* (Interface de Programação de Aplicação). Ela consiste em um conjunto de padrões e rotinas que atuam como uma ponte entre sistemas.\
\
Na prática, a API funciona como uma intermediária entre o **Consistem ERP** e outros programas: ela recebe uma solicitação, verifica se o solicitante possui as permissões adequadas e, se autorizado, entrega os dados conforme as regras estabelecidas.

### Licenciamento e Uso

* **Ambiente de Homologação (Testes)**\
  Todas as APIs desenvolvidas estão liberadas para uso e testes neste ambiente.
* **Ambiente de Produção**\
  Para utilizar as APIs no ambiente real de trabalho, é necessário realizar o licenciamento junto ao setor comercial da Consistem.

{% hint style="warning" %} <mark style="color:$danger;">**Importante**</mark>\
Esta documentação de API reflete sempre a versão mais recente do sistema, em conformidade com a [Política de Ciclo de Vida do Consistem ERP](https://cliente.consistem.com.br/normas/ciclo-de-vida/).\
Caso sua instalação utilize uma versão anterior, algumas funcionalidades aqui descritas podem não estar disponíveis.
{% 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 by asking a question.

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

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