Pular para conteúdo

Postman

Planos¶

Planos são configurados e gerenciados exclusivamente pela MediQuo. O parceiro pode apenas consultá-los.

`GET /plans`¶

Retorna a lista paginada de planos disponíveis para o parceiro autenticado.

Parâmetros da Query¶

Nome	Tipo	Obrigatório	Descrição
page	integer	não	Número da página (padrão: 0)
size	integer	não	Itens por página (padrão: 20)
sort	string	não	Ordenação (ex: `name,asc`)
index	string	não	Filtro de busca por nome

Cabeçalhos¶

Header	Valor
`Authorization`	`Bearer {token}`
`Accept`	`application/hal+json`

Exemplo de Requisição¶

Bash

curl -X GET "https://api-portal.mediquo.com.br/plans?page=0&size=20" \
  -H "Authorization: Bearer {seu_token}" \
  -H "Accept: application/hal+json"

Resposta de Sucesso: `200 OK`¶

JSON

{
  "totalPages": 1,
  "totalElements": 2,
  "content": [
    {
      "id": 1,
      "name": "Plano Básico",
      "active": true,
      "partnerId": 1,
      "pricing": 49.90,
      "maxRedemptions": 10,
      "estimatedQuantity": 1000,
      "discountRangeOneQuantity": 100,
      "discountRangeOnePercentage": 5,
      "discountRangeTwoQuantity": 500,
      "discountRangeTwoPercentage": 10,
      "omni": false,
      "familharia": false,
      "createdAt": "2025-01-01T10:00:00.000Z",
      "updatedAt": "2025-01-15T14:30:00.000Z"
    }
  ]
}

Campos do Plano¶

Campo	Tipo	Descrição
`id`	integer	ID do plano
`name`	string	Nome do plano
`active`	boolean	Indica se o plano está ativo
`partnerId`	integer	ID do parceiro associado
`pricing`	number	Valor unitário do plano (R$)
`maxRedemptions`	integer	Máximo de resgates por licença
`estimatedQuantity`	integer	Quantidade estimada de licenças
`discountRangeOneQuantity`	integer	Quantidade mínima para 1ª faixa de desconto
`discountRangeOnePercentage`	number	Percentual da 1ª faixa
`discountRangeTwoQuantity`	integer	Quantidade mínima para 2ª faixa de desconto
`discountRangeTwoPercentage`	number	Percentual da 2ª faixa
`discountRangeThreeQuantity`	integer	Quantidade mínima para 3ª faixa de desconto
`discountRangeThreePercentage`	number	Percentual da 3ª faixa
`discountRangeFourQuantity`	integer	Quantidade mínima para 4ª faixa de desconto
`discountRangeFourPercentage`	number	Percentual da 4ª faixa
`discountRangeFivePercentage`	number	Percentual da 5ª faixa
`omni`	boolean	Plano habilitado para Omni
`familharia`	boolean	Plano habilitado para Familiares

Os descontos são aplicados progressivamente conforme a quantidade de licenças contratadas.

Respostas de Erro¶

Código	Descrição
401	Token inválido ou expirado
403	Sem permissão