> For the complete documentation index, see [llms.txt](https://ajuda.pdvlegal.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.pdvlegal.com.br/integracoes/como-utilizar-a-nossa-api.md).

# Como utilizar a nossa API

{% hint style="danger" %}
Este manual é destinado aos **canais autorizados** do PDV Legal.

Para iniciar esse procedimento, entre em contato com o responsável pela sua conta. Ele orienta o acesso e fornece as credenciais necessárias.
{% endhint %}

Use a API para integrar sistemas externos aos recursos disponíveis no PDV Legal.

A documentação da API lista os métodos, parâmetros e respostas de cada operação.

{% hint style="warning" %}
As credenciais são exclusivas de cada canal e grupo econômico. Não compartilhe `password`, `client_secret` ou tokens em canais públicos.
{% endhint %}

## 1. Acesse a documentação

No menu do OEM, abra **Manuais e Documentação**.

{% hint style="info" %}
Conforme suas permissões, essa opção também pode aparecer como **Central de Documentação**.
{% endhint %}

Acesse **Integrações** e selecione o [**link da API**](https://api.tabletcloud.com.br).

Nessa página, você encontra:

* ajuda para autenticação
* métodos disponíveis
* detalhes de parâmetros e respostas

## 2. Reúna as credenciais

Para gerar o token, informe os cinco dados abaixo:

* `username` e `password` — fornecidos pelo responsável pela conta
* `grant_type` — mantenha o valor `password`
* `client_id` — código do grupo econômico
* `client_secret` — token do grupo econômico

O responsável pela conta fornece `username` e `password` do canal autorizado.

O código do grupo econômico corresponde ao `client_id`. O token desse grupo corresponde ao `client_secret`.

<figure><img src="/files/7wELEErV2MuMBBm0KDAJ" alt=""><figcaption></figcaption></figure>

## 3. Gere o token

Na seção de geração de token da documentação, consulte os campos com as credenciais da revenda e do grupo econômico.

Mantenha `grant_type` como `password`.

Após gerar o token, use-o para autenticar as chamadas aos métodos da API.

{% hint style="info" %}
Use as credenciais do grupo econômico correto. Cada grupo possui seu próprio `client_id` e `client_secret`.

<img src="/files/wCbp3Uvpg6sM30vJ0s6q" alt="" data-size="original">
{% endhint %}

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

## 4. Consulte e use os métodos

Com o token gerado, escolha o método necessário na documentação da API.

Revise os parâmetros obrigatórios antes de enviar a requisição. Use os exemplos e as respostas documentadas para validar sua integração.

{% hint style="info" %}
Para solicitar credenciais ou esclarecer o acesso, entre em contato com o responsável pela conta.
{% endhint %}


---

# 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://ajuda.pdvlegal.com.br/integracoes/como-utilizar-a-nossa-api.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.