Foi disponibilizado está rota, para que seja possível o "parceiro" visualizar algumas informações de seus respectivos clientes, cadastrados no Plug Storage.
Segue abaixo informações para construir da requisição.
GET
Query Params
| Nome | Descrição |
| cnpj_cpf | CNPJ ou CPF para identificar o cliente (opcional). |
| user_id | O ID do cliente também pode ser utilizado para identificar o mesmo (opcional). |
| E-mail também pode ser utilizado na busca (opcional). | |
| hashProximaPagina | A busca será retornada com no máximo 100 registros, por isso, insira este campo para consultar os demais clientes. Por exemplo: se existirem 150 clientes, na primeira consulta será retornado 100. Já na próxima busca, utilizando o hashProximaPagina com o valor que recomendamos, irá retornar os 50 registros restantes. |
OBS.: Não informar os parâmetros cnpj_cpf, user_id e email caso desejar obter o retorno de todos os seus clientes.
Headers
| Nome | Valor |
|
Accept
|
application/json
|
| Authorization | Basic encode64(tokenParceiro:senhaParceiro) |
Body
Neste caso o BODY pode ser enviado como vazio, pois todos os parâmetros de entrada são enviados na URL.
Retorno
Exemplo de retorno utilizando o cnpj_cpf ou user_id ou email como parâmetro da busca:
{
"error": false,
"message": "Cliente Encontrado",
"client": {
"Id": 6526,
"Name": "Tecnospeed",
"Corporate name": "Tecnospeed S/A",
"CNPJ": "08157168000160",
"CPF": null,
"E-mail": "teste@test.com.br",
"Status": "active",
"Registration date": "2017-12-07 08:47:18"
}
}
Exemplo de retorno sem utilizar o cnpj_cpf, user_id, email ou utilizando algum valor em hashProximaPagina como parâmetro da busca:
{
"error": false,
"message": "Cliente Encontrado",
"client": [
{
"Id": 6526,
"Name": "Tecnospeed",
"Corporate name": "Tecnospeed S/A",
"CNPJ": "08157168000160",
"CPF": null,
"E-mail": "teste@test.com.br",
"Status": "active",
"Registration date": "2017-12-07 08:47:18"
},
{
"Id": 6527,
"Name": "Tecnospeed",
"Corporate name": "Tecnospeed S/A",
"CNPJ": "08157168000160",
"CPF": null,
"E-mail": "teste@test.com.br",
"Status": "active",
"Registration date": "2017-12-07 08:47:18"
}
],
"hashProximaPagina": 1200
}
Exemplo de retorno com erro:
{
"error": true,
"message": "Cliente não encontrado. Por favor, verifique o parâmetro informado!"
}
Comentários
0 comentário
Por favor, entre para comentar.