Dupay

Esta chamada de API é utilizada para a criação de planos, que são usados nas assinaturas. Os planos são uma combinação de um ou mais produtos, formando um combo onde pode-se ter descontos para a compra do pacote.

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

Parâmetros a serem enviados:

method = “cadastrarPlano”
name = Nome do plano
description = Opcional* - Descrição mais completa sobre o produto.
interval = Intervalo de cobrança. Usado em conjunto com o tipo_intervalo
intervalType = Tipo do intervalo de cobrança. Usar M para Mensal e S para Semanal
paymentAccepted = Métodos de pagamentos aceitos. T = Todos, B = Boleto, C = Cartao.
products = Deve ser enviado um array de objetos contendo os produtos a serem cadastrados. O objeto dentro do array deve conter:
productId = Codigo do produto
quantity = Quantidade do produto.
price = Preço unitário que será cobrado por produto.

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": "newPlan",
    "name": "Plano Teste da API",
    "description": "Plano criado através da chamada de API pelo programa POSTMAN.",
    "interval": "1",
    "intervalType": "M",
    "paymentAccepted": "B",
    "products": [
        {
            "productId": "916",
            "quantity": "1",
            "price": "39.90"
        }
    ]
}

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

{
    "status": 1,
    "message": "Plano cadastrado com sucesso!",
    "data": {
        "planId": "284",
        "name": "Plano Teste da API",
        "description": "Plano criado através da chamada de API pelo programa POSTMAN.",
        "subTotal": "39.90",
        "discountPercent": "0.00",
        "discountValue": "0.00",
        "value": "39.90",
        "interval": "1",
        "intervalType": "M",
        "creationDate": "2019-06-12 15:14:24",
        "paymentAccepted": "B"
    }
}