Esta chamada de API será utilizada para alteração das assinaturas no sistema. Para o uso da API basta encaminhar o valor que deseja alterar, não é necessário enviar todos os campos para a requisição.
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: editSignature
Parâmetros a serem enviados:
method = “editSignature”
signatureId = Id da assiantura a ser editada
customerId = Código do cliente
planId = Código do plano
firstDueDate = Primeira data de vencimento da assinatura
paymentAccepted = Método de pagamento. B = Boleto, C = Cartao. Deve ser informado somente se o plano permitir as 2 formas de pagamento.
planValue = Valor do plano
discountPercent = Porcentagem de desconto. (Em cima do PlanValue)
autoRenew = Regra de renovação automática. 1 para sim, 0 para não
duration = Duração em meses ou semanas para a assinatura
nextDueDate = Próxima data de vencimento.
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": "editSignature", "signatureId": "1022", "customerId": 2995, "planId": "284", "firstDueDate": "2019-06-21", "paymentAccepted": "B", "planValue": "29.90", "discountPercent": 10, "autoRenew": "0", "duration": "6", "nextDueDate": "2019-07-20" }
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: