Nuvem de Recompensas

Endpoint

Método HTTP: GET

URL: /clouds/{name}/prizes

Aviso

Consulte Nova Nuvem de Recompensas para saber mais sobre novos recursos, melhorias de desempenho e guia de migração.

Parâmetros de Consulta

Parâmetro	Tipo	Descrição
names	string[]	Lista de nomes de recompensas, separados por vírgula. Filtra recompensas pelo campo name de prizes. Se omitido, retorna todas as recompensas disponíveis.

Exemplo de uso:

GET https://api.minu.biz/v2/clouds/cloud/prizes?names=cupom-ifood-20,uber-desconto-r20

Parâmetros de Projeção

Informação

Use qualquer uma das propriedades listadas na tabela de Propriedades de Resposta como parâmetro de projeção, através do parâmetro de consulta fields. Isso permite retornar apenas os campos desejados em cada item da resposta.

Exemplo de uso:

GET https://api.minu.biz/v2/clouds/cloud/prizes?fields=name,title,faceValue,photo

Retorna apenas os campos name, title, faceValue e photo em cada item da resposta. Importante: field name é um campo chave, sempre sera exibido.

Exemplo de Requisição

curl --request GET \
  --url https://api.minu.biz/v2/clouds/cloud/prizes \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>'

Propriedades de Resposta

Se a requisição for bem-sucedida, a API retornará as seguintes propriedades no formato JSON.

Propriedade	Tipo	Descrição
name	string	Identificador único da recompensa na plataforma Minu.biz.
title	string	Título da recompensa exibido na plataforma.
description	string	Descrição breve da recompensa.
alliance	object	Informações sobre a aliança que oferece a recompensa.
alliance.name	string	Nome da Aliança que disponibiliza as recompensas.
alliance.title	string	Título da Aliança que disponibiliza as recompensas.
group	object	Informações do grupo ao qual a recompensa pertence.
group.name	string	Identificador do grupo.
group.title	string	Nome do grupo.
group.subGroup	object	Informações da categoria da recompensa.
group.subGroup.name	string	Identificador da categoria.
group.subGroup.title	string	Nome do categoria.
faceValue	integer	Valor da recompensa para o consumidor.
billing	object	Informações sobre cobrança e taxas para o cliente corporativo.
billing.price	double	Valor da recompensa para o cliente corporativo.
billing.processingFee	double	Taxa de processamento associada à recompensa.
requiredMobile	boolean	Indica se numero de telefone é exigido para entrega da recompensa.
icon	object	Ícone representativo da recompensa.
icon.href	string	URL do ícone.
icon.srcset	string	Srcset do ícone para diferentes resoluções.
wideBanner	object	Banner amplo da recompensa.
wideBanner.href	string	URL do banner.
wideBanner.srcset	string	Srcset do banner para diferentes resoluções.
photo	object	Foto principal da recompensa.
photo.href	string	URL da foto.
photo.srcset	string	Srcset da foto para diferentes resoluções.
deliveryData	object	Dados de entrega da recompensa.
deliveryData.deadline	string	Prazo de entrega da recompensa.
deliveryData.guideline	string	Orientações para entrega.
rules	array	Lista de regras aplicáveis à recompensa.
rules[].name	string	Nome da regra.
rules[].value	array	Valores associados à regra.
deliveryAddress	object	Informações sobre endereço de entrega, se aplicável.
deliveryAddress.questions	array	Perguntas para coleta de dados de entrega.
deliveryAddress.questions[].name	string	Nome do campo da pergunta.
deliveryAddress.questions[].text	string	Texto exibido ao usuário.
deliveryAddress.questions[].required	boolean	Indica se a resposta é obrigatória.
deliveryAddress.questions[].field	string	Tipo de campo (ex: texto, número).
deliveryAddress.questions[].example	string	Exemplo de resposta esperada.

Exemplo de Resposta

[
  {
    "name": "cupom-ifood-20",
    "title": "Cupom iFood R$20",
    "description": "Cupom de desconto para utilizar no iFood.",
    "alliance": {
      "name": "ifood",
      "title": "iFood"
    },
    "group": {
      "name": "alimentacao",
      "title": "Alimentação",
      "subGroup": {
        "name": "delivery",
        "title": "Delivery"
      }
    },
    "faceValue": 20,
    "billing": {
      "price": 12,
      "processingFee": 0.5,
    },
    "requiredMobile": false,
    "icon": {
      "href": "https://cdn.minu.biz/icons/prize-icon.png",
      "srcset": "prize-icon.png 1x, prize-icon@1.5x.png 1.5x, prize-icon@2x.png 2x, prize-icon@3x.png 3x, prize-icon@4x.png 4x"
    },
    "wideBanner": {
      "href": "https://cdn.minu.biz/banners/wideBanner.png",
      "srcset": "wideBanner.png 1x, wideBanner@1.5x.png 1.5x, wideBanner@2x.png 2x, wideBanner@3x.png 3x, wideBanner@4x.png 4x"
    },
    "photo": {
      "href": "https://cdn.minu.biz/photos/prize-photo.png",
      "srcset": "prize-photo.png 1x, prize-photo@1.5x.png 1.5x, prize-photo@2x.png 2x, prize-photo@3x.png 3x, prize-photo@4x.png 4x"
    },
    "deliveryData": {
      "deadline": "Até 24 horas",
      "guideline": "O cupom será enviado por e-mail cadastrado."
    },
    "rules": [
      { "name": "quantidade_minima", "value": [1] },
      { "name": "quantidade_maxima", "value": [10] }
    ],
    "deliveryAddress": {
      "questions": [
        {
          "name": "email",
          "text": "Informe o e-mail para entrega do cupom",
          "required": true,
          "field": "email",
          "example": "usuario@email.com"
        }
      ]
    }
  }
]