Esta chamada de API será utilizada para o cadastro dos clientes no sistema. O cadastro dos clientes é obrigatório para a geração de faturas ou assinaturas.
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.
É importante que envie os dados corretos do cliente, principalmente documentos e endereço pois os mesmos são validados pelo sistema bancário para a geração dos boletos e caso tenha algum dado inválido poderá ocorrer falha no registro da cobrança.
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: newCustomer
Parâmetros a serem enviados:
method = “newCustomer”
name= Nome Completo ou Razão Social
document = CPF ou CNPJ
phoneNumber = Telefone de contato
birthDate = Opcional* - Data de nascimento
email = email do cliente. Será usado esse email para envio das faturas.
zipCode = Cep do endereço do cliente.
address = Logradouro
number = Número da residência ou estabelecimento comercial. Enviar números ou “S/N”
complement = Opcional* - Complemento do endereço
district = Bairro do cliente
city = Nome da cidade do cliente
state = Sigla do estado do cliente. 2 letras.
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": "newCustomer", "name": "Cliente de Teste de API", "document": "89719029064", "phoneNumber": "2733334444", "birthDate": "", "email": "teste@teste.com.br", "zipCode": "01.311-200", "address": "Avenida Paulista", "number": "1079", "complement": "", "district": "Bela Vista", "city": "São Paulo", "state": "SP" }
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 cadastro de clientes:
{ "status": 1, "message": "Cliente cadastrado com sucesso", "data": { "clientId": "3052", "name": "Cliente de Teste de API", "document": "89719029064", "phoneNumber": "2733334444", "birthDate": "", "email": "teste@teste.com.br", "zipCode": "01311200", "address": "Avenida Paulista", "number": "1079", "district": "Bela Vista", "city": "São Paulo", "state": "SP" } }