Licenças¶

Licenças concedem acesso individual ao App MediQuo. São vinculadas a um cliente e a um plano.

`GET /licences`¶

Retorna a lista paginada de licenças.

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

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/licences?page=0&size=20" \
  -H "Authorization: Bearer {seu_token}" \
  -H "Accept: application/hal+json"

Respostas¶

Código	Descrição
200	Lista paginada de licenças
401	Token inválido ou expirado
403	Sem permissão

`GET /licences/{id}`¶

Retorna os dados de uma licença específica.

Parâmetros do Path¶

Nome	Tipo	Obrigatório	Descrição
id	integer	sim	ID da licença

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/licences/1 \
  -H "Authorization: Bearer {seu_token}" \
  -H "Accept: application/hal+json"

Respostas¶

Código	Descrição
200	Dados da licença
401	Token inválido ou expirado
403	Sem permissão
404	Licença não encontrada

`GET /licences/find-by-code/{code}`¶

Retorna os dados de uma licença pelo seu código.

Parâmetros do Path¶

Nome	Tipo	Obrigatório	Descrição
code	string	sim	Código da licença

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/licences/find-by-code/LIC-2025-001 \
  -H "Authorization: Bearer {seu_token}" \
  -H "Accept: application/hal+json"

Respostas¶

Código	Descrição
200	Dados da licença
401	Token inválido ou expirado
403	Sem permissão
404	Licença não encontrada

`POST /licences/integration/queue-licence`¶

Envia uma nova licença para a fila de processamento assíncrono. A criação efetiva da licença ocorre em background — use o Webhook para receber o callback de sucesso ou falha.

Processamento Assíncrono

Este endpoint retorna 202 Accepted imediatamente após enfileirar a solicitação. A fila é processada em milissegundos — o resultado final (sucesso ou erro) é entregue via webhook configurado no seu sistema.

Consulte: Webhook

Cabeçalhos¶

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

Corpo da Requisição¶

Campo	Tipo	Obrigatório	Descrição
clientId	integer	sim	ID do cliente
code	string	sim	Código único da licença
name	string	sim	Nome do titular
phoneNumber	string	sim	Telefone com DDD (ex: `11999999999`)
planId	integer	sim	ID do plano
email	string	não	E-mail do titular
phoneNumberCode	string	não	Código do país (ex: `+55`)
branchId	integer	não	ID da filial
documentNumber	string	não	CPF do titular (somente números)
birthDate	string	não	Data de nascimento (`ISO 8601`)
gender	string	não	`MALE` ou `FEMALE`
observations	string	não	Observações livres
mediquoNotificationEmail	boolean	não	Ativar notificações por e-mail
mediquoNotificationSMS	boolean	não	Ativar notificações por SMS

Exemplo de Requisição¶

Bash

curl -X POST https://api-portal.mediquo.com.br/licences/integration/queue-licence \
  -H "Authorization: Bearer {seu_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "clientId": 1,
    "code": "LIC-2025-001",
    "name": "Maria Silva",
    "phoneNumber": "11999999999",
    "phoneNumberCode": "+55",
    "planId": 1,
    "email": "maria@email.com",
    "mediquoNotificationEmail": true,
    "mediquoNotificationSMS": true
  }'

Resposta de Sucesso — `202 Accepted`¶

JSON

{
  "message": "Licence successfully sent to processing queue",
  "licenceCode": "LIC-2025-001",
  "status": "QUEUED",
  "queueCode": "msg-abc123-def456"
}

Campos da Resposta¶

Campo	Tipo	Descrição
`message`	string	Descrição do resultado do enfileiramento
`licenceCode`	string	Código da licença enviada à fila
`status`	string	`QUEUED` (enfileirado com sucesso) ou `ERROR` (falha ao enfileirar)
`queueCode`	string	ID da mensagem na fila (SQS Message ID)

Respostas de Erro¶

Código	Descrição
400	Campos obrigatórios ausentes ou inválidos
401	Token inválido ou expirado
403	Sem permissão
404	Cliente ou plano não encontrado

`PUT /licences/{id}`¶

Atualiza os dados de uma licença.

Parâmetros do Path¶

Nome	Tipo	Obrigatório	Descrição
id	integer	sim	ID da licença

Cabeçalhos¶

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

Corpo da Requisição¶

Campo	Tipo	Obrigatório	Descrição
clientId	integer	sim	ID do cliente
code	string	sim	Código único da licença
name	string	sim	Nome do titular
phoneNumber	string	sim	Telefone com DDD
planId	integer	não	ID do plano
email	string	não	E-mail do titular
phoneNumberCode	string	não	Código do país
branchId	integer	não	ID da filial
documentNumber	string	não	CPF do titular
birthDate	string	não	Data de nascimento
gender	string	não	`MALE`, `FEMALE` ou `OTHER`
observations	string	não	Observações livres
mediquoNotificationEmail	boolean	não	Notificações por e-mail
mediquoNotificationSMS	boolean	não	Notificações por SMS

Exemplo de Requisição¶

Bash

curl -X PUT https://api-portal.mediquo.com.br/licences/1 \
  -H "Authorization: Bearer {seu_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "clientId": 1,
    "code": "LIC-2025-001",
    "name": "Maria Silva Atualizada",
    "phoneNumber": "11988888888"
  }'

Respostas¶

Código	Descrição
200	Licença atualizada — retorna o objeto completo
400	Requisição inválida
401	Token inválido ou expirado
403	Sem permissão
404	Licença não encontrada

`PUT /licences/deactivate/{id}`¶

Desativa uma licença pelo ID.

Parâmetros do Path¶

Nome	Tipo	Obrigatório	Descrição
id	integer	sim	ID da licença

Cabeçalhos¶

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

Exemplo de Requisição¶

Bash

curl -X PUT https://api-portal.mediquo.com.br/licences/deactivate/1 \
  -H "Authorization: Bearer {seu_token}"

Respostas¶

Código	Descrição
200	`true`
401	Token inválido ou expirado
403	Sem permissão
404	Licença não encontrada

`PUT /licences/deactivate-by-code/{code}`¶

Desativa uma licença pelo código.

Parâmetros do Path¶

Nome	Tipo	Obrigatório	Descrição
code	string	sim	Código da licença

Cabeçalhos¶

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

Exemplo de Requisição¶

Bash

curl -X PUT https://api-portal.mediquo.com.br/licences/deactivate-by-code/LIC-2025-001 \
  -H "Authorization: Bearer {seu_token}"

Respostas¶

Código	Descrição
200	`true`
401	Token inválido ou expirado
403	Sem permissão
404	Licença não encontrada

`PUT /licences/activate/{id}`¶

Ativa uma licença pelo ID.

Parâmetros do Path¶

Nome	Tipo	Obrigatório	Descrição
id	integer	sim	ID da licença

Cabeçalhos¶

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

Exemplo de Requisição¶

Bash

curl -X PUT https://api-portal.mediquo.com.br/licences/activate/1 \
  -H "Authorization: Bearer {seu_token}"

Respostas¶

Código	Descrição
200	`true`
401	Token inválido ou expirado
403	Sem permissão
404	Licença não encontrada

`PUT /licences/activate-by-code/{code}`¶

Ativa uma licença pelo código.

Parâmetros do Path¶

Nome	Tipo	Obrigatório	Descrição
code	string	sim	Código da licença

Cabeçalhos¶

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

Exemplo de Requisição¶

Bash

curl -X PUT https://api-portal.mediquo.com.br/licences/activate-by-code/LIC-2025-001 \
  -H "Authorization: Bearer {seu_token}"

Respostas¶

Código	Descrição
200	`true`
401	Token inválido ou expirado
403	Sem permissão
404	Licença não encontrada

`POST /licences/resend-notification/{id}`¶

Reenvia a notificação de acesso ao titular da licença.

Parâmetros do Path¶

Nome	Tipo	Obrigatório	Descrição
id	integer	sim	ID da licença

Parâmetros da Query¶

Nome	Tipo	Obrigatório	Descrição
type	string	sim	Canal de envio: `EMAIL`, `SMS` ou `BOTH`

Cabeçalhos¶

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

Exemplo de Requisição¶

Bash

curl -X POST "https://api-portal.mediquo.com.br/licences/resend-notification/1?type=BOTH" \
  -H "Authorization: Bearer {seu_token}"

Respostas¶

Código	Descrição
200	Notificação enviada — retorna o objeto da licença
401	Token inválido ou expirado
403	Sem permissão
404	Licença não encontrada

Licenças¶

GET /licences¶

Parâmetros da Query¶

Cabeçalhos¶

Exemplo de Requisição¶

Respostas¶

GET /licences/{id}¶

Parâmetros do Path¶

Cabeçalhos¶

Exemplo de Requisição¶

Respostas¶

GET /licences/find-by-code/{code}¶

Parâmetros do Path¶

Cabeçalhos¶

Exemplo de Requisição¶

Respostas¶

POST /licences/integration/queue-licence¶

Cabeçalhos¶

Corpo da Requisição¶

Exemplo de Requisição¶

Resposta de Sucesso — 202 Accepted¶

Campos da Resposta¶

Respostas de Erro¶

PUT /licences/{id}¶

Parâmetros do Path¶

Cabeçalhos¶

Corpo da Requisição¶

Exemplo de Requisição¶

Respostas¶

PUT /licences/deactivate/{id}¶

Parâmetros do Path¶

Cabeçalhos¶

Exemplo de Requisição¶

Respostas¶

PUT /licences/deactivate-by-code/{code}¶

Parâmetros do Path¶

Cabeçalhos¶

Exemplo de Requisição¶

Respostas¶

PUT /licences/activate/{id}¶

Parâmetros do Path¶

Cabeçalhos¶

Exemplo de Requisição¶

Respostas¶

PUT /licences/activate-by-code/{code}¶

Parâmetros do Path¶

Cabeçalhos¶

Exemplo de Requisição¶

Respostas¶

POST /licences/resend-notification/{id}¶

Parâmetros do Path¶

Parâmetros da Query¶

Cabeçalhos¶

Exemplo de Requisição¶

Respostas¶

`GET /licences`¶

`GET /licences/{id}`¶

`GET /licences/find-by-code/{code}`¶

`POST /licences/integration/queue-licence`¶

Resposta de Sucesso — `202 Accepted`¶

`PUT /licences/{id}`¶

`PUT /licences/deactivate/{id}`¶

`PUT /licences/deactivate-by-code/{code}`¶

`PUT /licences/activate/{id}`¶

`PUT /licences/activate-by-code/{code}`¶

`POST /licences/resend-notification/{id}`¶