Como utilizar a nossa API

Acesse a documentação da API, obtenha as credenciais e gere o token para usar os métodos disponíveis.

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.

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.

As credenciais são exclusivas de cada canal e grupo econômico. Não compartilhe password, client_secret ou tokens em canais públicos.

1. Acesse a documentação

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

Conforme suas permissões, essa opção também pode aparecer como Central de Documentação.

Acesse Integrações e selecione o link da API.

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.

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.

Use as credenciais do grupo econômico correto. Cada grupo possui seu próprio client_id e client_secret.

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.

Para solicitar credenciais ou esclarecer o acesso, entre em contato com o responsável pela conta.