Dupay

A API de planos serve para fazer ajuste nos planos existentes. Caso o plano já tenha sido usado em alguma assinatura, a API permite que apenas seu nome e descrição possa ser alterado. Caso ainda não tenha sido usado, poderá ser feito outros ajustes.

Para ajuste dos produtos que compõem o plano e seu valor final, deve-se chamar as funções referentes aos produtos do planos. (Listagem, inclusão, atualização e exclusã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”

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI5OGYxMzcwODIxMDE5NGM0NzU2ODdiZTYxMDZhM2I4NCIsImVtcHJlc2EiOiI5OGYxMzcwODIxMDE5NGM0NzU2ODdiZTYxMDZhM2I4NCIsImxvZ2luIjoidGVzdGVzQGR1cGF5LmNvbS5iciIsImNsaWVudGUiOm51bGwsImdydXBvIjoiMiIsImV4cCI6MTU2MDE3MTg5MiwiaWF0IjoxNTU5OTk5MDkyfQ.DKycS9HX68c0wDTAoGq2Y3rts-Dqtm_cOugsVKpMq9U

MÉTODO DA API: editPlan

Parâmetros a serem enviados:

method = “editPlan”
planId = Opcional* - Código do plano
name = Opcional* - Nome a ser pesquisado, minimo de 3 caracteres.
paymentAccepted = Opcional* - Lista apenas com o método de pagamento informado.
interval = Quantidade do intervalo de cobrança do plano.
intervalType = tipo de intervalo, M para meses e S para semanas.
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": "editPlan",
    "planId": "278",
    "name": "Plano Teste da API",
    "description": "Plano criado através da chamada de API pelo programa POSTMAN.",
    "interval": "1",
    "intervalType": "M",
    "paymentAccepted": "B"
}

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 planos:

{
    "status": 1,
    "message": "Plano atualizado com sucesso",
    "data": {
        "planId": "278",
        "name": "Plano Teste da API",
        "description": "Plano criado através da chamada de API pelo programa POSTMAN.",
        "subTotal": "59.90",
        "discountPercent": "0.00",
        "discountValue": "0.00",
        "value": "59.90",
        "interval": "1",
        "intervalType": "M",
        "creationDate": "2019-06-11 10:00:51",
        "paymentAccepted": "B"
    }
}