Esta chamada de API permite a listagem das assinaturas cadastradas no sistema. Permite filtro por ID da Assinatura, ID do Cliente e ID do Plano.
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: listSignatureProduct
Parâmetros a serem enviados:
method = “listSignatureProduct”
signatureId = ID da Assinatura
customerId = ID do Cliente
planId = ID do plano
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": "listSignature", "signatureId": "1022", "customerId": "2995", "planId": "284" }
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 do JSON:
{ "status": 1, "message": "OK", "data": [ { "signatureId": "1022", "customerId": "2995", "planId": "284", "firstDueDate": "2019-06-21", "discountPercent": "10.00", "discountValue": "2.99", "paymentAccepted": "C", "planValue": "29.90", "autoRenew": "0", "duration": "M", "expireDate": "2019-12-21" } ] }