Dados de acesso
Para acessar a api, você precisará dos seguintes dados
Endereço: https://exemplo.puze.com.br
Usuário: exemplo
Chave: 39xv1olbQ5K2qdTPuKNL0GP
Autenticação
Autorização básica. Enviar os dados “usuario:chave” codificados em base 64
Exemplo:
Authorization: Basic ZXhlbXBsbzozOXh2MW9sYlE1SzJxZFRQdUtOTDBHUA==
Retorno
Formato JSON. Os dados retornados dependem do módulo de consulta. Também informa se houver mais de 100 registros, caso em que deve ser usado o parâmetro “pag”.
Cadastro (GET)
Retorna todos os registros a não ser que informado os campos id ou busca.
|
Nome |
Exemplo |
Descrição |
|
modulo* |
cadastro |
Módulo a ser acessado |
|
id |
- |
Valor numérico. Se informado, retorna somente o cadastro referente ao id informado. |
|
busca |
Jo%C3%A3o+Silva |
Valor alfanumérico com codificação de URL.Busca por valores dentro do cadastro como “nome, endereço, email” para encontrar um registro específico. Retorna lista de cadastros encontrados. |
|
pag |
1 |
Valor numérico. Informa a paginação para o caso de consultas com mais de 100 registros. Padrão: 1. |
Produtos (GET)
Retorna todos os registros a não ser que informado os campos id ou busca.
|
Nome |
Exemplo |
Descrição |
|
modulo* |
produtos |
Módulo a ser acessado |
|
id |
2 |
Valor numérico. Se informado, retorna somente o cadastro referente ao id informado. |
|
busca |
produto+azul |
Valor alfanumérico com codificação de URL.Busca por valores dentro do produto como “nome, descrição” para encontrar um registro específico. Retorna lista de produtos encontrados. |
|
pag |
2 |
Valor numérico. Informa a paginação para o caso de consultas com mais de 100 registros. Padrão: 1. |
Pedidos (GET)
Retorna todos os registros no período selecionado. Opcionalmente pode retornar uma lista específica com os campos id_cadastro, id ou busca.
|
Nome |
Exemplo |
Descrição |
|
modulo* |
pedidos |
Módulo a ser acessado |
|
de* |
14-06-2020 |
Data no formato dd-mm-aaaa. Data inicial de intervalo da lista de pedidos. Pode ser omitido se informado id_cadastro, id ou busca. |
|
ate* |
14-07-2020 |
Data no formato dd-mm-aaaa. data final de intervalo da lista de pedidos. Pode ser omitido se informado id_cadastro, id ou busca. |
|
id_cadastro |
2 |
Valor numérico. Se informado, retorna lista de pedidos do cliente. |
|
id |
2 |
Valor numérico. Se informado, retorna somente o registro referente ao id informado. |
|
busca |
pedido |
Valor alfanumérico com codificação de URL. Busca por valores dentro do pedido como “nome do produto, nome do cliente, endereço, email” para encontrar um registro específico. Retorna lista de pedidos encontrados. |
|
pag |
2 |
Valor numérico. Informa a paginação para o caso de consultas com mais de 100 registros. Padrão: 1. |