Esta chamada de API permite consultar os clientes cadastrados no sistema. A API pode ser usada para listar todos os clientes ou ainda com filtro, por ID, CPF ou CNPJ ou busca por nome


A chamada dessa API deve ser autenticada por meio de token no header da requisição, token este que deve ser gerado utilizando a API de Autenticação.


Todas as requisições à API devem utilizar o método HTTP POST. A API recusa qualquer outro método que não seja o POST nas requisições.


ENVIO DO TOKEN

O token deve ser enviado no header da requisição, no seguinte formato:

“Authorization” : “Bearer seu_token_gerado_aqui”


Exemplo:

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI5OGYxMzcwODIxMDE5NGM0NzU2ODdiZTYxMDZhM2I4NCIsImVtcHJlc2EiOiI5OGYxMzcwODIxMDE5NGM0NzU2ODdiZTYxMDZhM2I4NCIsImxvZ2luIjoidGVzdGVzQGR1cGF5LmNvbS5iciIsImNsaWVudGUiOm51bGwsImdydXBvIjoiMiIsImV4cCI6MTU2MDE3MTg5MiwiaWF0IjoxNTU5OTk5MDkyfQ.DKycS9HX68c0wDTAoGq2Y3rts-Dqtm_cOugsVKpMq9U


MÉTODO DA API: listCustomer


Parâmetros a serem enviados:


method = “listCustomer”
customerId = Opcional* - Código do cliente
name = Opcional* - Nome a ser pesquisado, minimo de 3 caracteres.
document = Opcional* - CPF ou CNPJ do cliente
limit = Opcional* - Limite máximo de registros a retornar. Padrão em 100, maximo 1000.
offset = Opcional* - Utilizado para paginação


URL DA API

https://painel.dupay.com.br/api_v1/?vkey=5343f84566a14db9f4a8f79c713085c3


Os dados devem ser enviados preferencialmente por JSON e a resposta da API sempre será em JSON.


Exemplo de chamada:

{
    "method": "listCustomer",
    "customerId": 2995,
    "name": "Cliente de Teste de API"
}


Todas as chamadas da API da Dupay respondem em JSON e possui algumas variáveis padrões na resposta. São elas:


status = Retorna 0 para falha e 1 para sucesso na chamada da API
message = Mensagem informativa em caso de falha na chamada da API
data = Dados retornados pela API em caso de sucesso na chamada.


Segue abaixo um exemplo de retorno JSON da chamada de listagem de clientes:


{
    "status": 1,
    "message": "Consulta efetuada com sucesso",
    "data": [
        {
            "customerId": "2995",
            "name": "Cliente de Teste de API",
            "document": "50463317726",
            "birthDate": "",
            "email": "teste@teste.com.br",
            "zipCode": "01311200",
            "address": "Avenida Paulista",
            "number": "1079",
            "district": "Bela Vista",
            "city": "São Paulo",
            "state": "SP"
        }
    ]
}