> 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-funcionam-as-apis-rest-no-zeev.md).

# Como funcionam as APIs Rest no Zeev

Esta página contém informações passo a passo para você entender mais sobre o funcionamento de APIs no Zeev e integrações de sistemas externos

## Visão geral

Este conteúdo foi criado para que você compreenda e domine o uso de **APIs** de forma prática e aplicada ao seu dia a dia, mesmo que você não tenha formação técnica. 

Ao longo dos materiais, você vai entender como funcionam as integrações, como consultar e enviar dados com segurança, interpretar respostas em **JSON**, aplicar **filtros OData** e explorar possibilidades no Zeev. O objetivo é que ao final você se sinta capaz de **construir suas próprias integrações**, otimizando processos e usando as APIs do Zeev.

Antes de mais nada, é preciso entender como usar uma API no Zeev. Por isso é preciso compreender o conceito de **APIs** no contexto da nossa plataforma, visualizando o que são e por que você pode querer usá-las. 

{% embed url="<https://youtu.be/Yi3HaA5V_6Y>" %}

## Conceitos básicos

Além de entender o que é uma API, é preciso compreender alguns conceitos básicos. APIs (Application Programming Interfaces) permitem que diferentes sistemas “conversem” entre si, ou seja, você pode fazer o Zeev enviar e receber dados com outras ferramentas de forma automatizada. O exemplo usado aqui no vídeo é uma comparação com um aplicativo de delivery.

{% embed url="<https://youtu.be/lLMhBz-1UNM>" %}

## Como funciona uma API Rest

Existem diversos tipos de APIs, como REST, SOAP e GraphQL. Aqui no Zeev utilizamos as APIs do tipo Rest.

As APIs do tipo Rest usam algumas partes, conhecidas como parâmetros. São elas:

<table data-header-hidden><thead><tr><th width="165">Parte / parâmetro</th><th width="280.2000732421875">Exemplo</th><th width="279.60003662109375">Função</th></tr></thead><tbody><tr><td><strong>PARTE</strong></td><td><strong>EXEMPLO</strong></td><td><strong>FUNÇÃO</strong></td></tr><tr><td>URL ou Endpoint</td><td>https://api.exemplo.com/users</td><td>Endereço da informação</td></tr><tr><td>Métodos HTTP</td><td>GET, POST, PUT, PATCH, DELETE</td><td>Tipo de ação</td></tr><tr><td>Headers</td><td>Authorization, Content-Type</td><td>Instruções iniciais de codificação</td></tr><tr><td>Body</td><td>JSON de entrada</td><td>É o corpo da requisição</td></tr></tbody></table>

Outro termo que você precisa se familiarizar ao lidar com as APIs Rest são os **Métodos**.&#x20;

<table data-header-hidden><thead><tr><th width="165"></th><th width="279.7999267578125"></th><th width="280.0001220703125"></th></tr></thead><tbody><tr><td><strong>MÉTODO</strong></td><td><strong>Ação principal</strong></td><td><strong>EXEMPLO PRÁTICO</strong></td></tr><tr><td>GET</td><td>Ler dados</td><td>Buscar um cliente</td></tr><tr><td>POST</td><td>Criar ou executar algo</td><td>Criar novo cliente ou uma busca mais complexa</td></tr><tr><td>PUT</td><td>Substituir recurso</td><td>Atualizar cliente por completo</td></tr><tr><td>PATCH</td><td>Atualizar parcialmente</td><td>Alterar apenas o e-mail do cliente</td></tr><tr><td>DELETE</td><td>Remover recurso</td><td>Deletar cliente</td></tr></tbody></table>

Ainda temos conteúdos sobre **códigos de retorno**, a **forma (em JSON)** com que os dados são retornados e o **passo a passo para consumir uma API Rest**.

{% embed url="<https://youtu.be/3CTKzX0G4Ss>" %}


---

# 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, and the optional `goal` query parameter:

```
GET https://kb.stoque.com.br/zeev/apis/como-funcionam-as-apis-rest-no-zeev.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.