QR Code Service API

GET /health

Verifica a integridade do servidor e se todas as conexões estão respondendo corretamente.

POST /v1/clients

Cadastra um novo cliente para consumo da API e retorna um token fixo de acesso seguro.

Exemplo de Payload (Request Body)

{
  "name": "Nome do Cliente",
  "email": "email@provedor.com"
}

POST /v1/qrcodes

Gera um QR Code a partir de uma URL enviada, faz upload da imagem para o Cloudinary e retorna a URL local do serviço.

Cabeçalho de Autenticação Requerido

Authorization: qr_token_obtido_no_cadastro  (ou: Bearer qr_token_...)

Exemplo de Payload (Request Body)

{
  "url": "https://github.com",
  "options": {
    "width": 300,
    "margin": 2,
    "color": {
      "dark": "#000000",
      "light": "#ffffff"
    }
  }
}

Exemplo de Retorno (Response JSON)

{
  "id": "uuid-do-qrcode",
  "originalUrl": "https://github.com",
  "qrCodeUrl": "http://localhost:3002/qrcodes/uuid-do-qrcode/image",
  "createdAt": "2026-05-28T16:00:00.000Z"
}

GET /qrcodes/:id/image

Rota pública para acessar a imagem do QR Code. Redireciona (302) automaticamente para o Cloudinary.

GET /v1/qrcodes

Lista os QR Codes gerados pelo cliente autenticado de forma paginada.

Cabeçalho de Autenticação Requerido

Authorization: qr_token_obtido_no_cadastro  (ou: Bearer qr_token_...)

Parâmetros de Consulta Opcionais (Query Params)

?page=1&limit=20

Exemplo de Retorno (Response JSON)

{
  "data": [
    {
      "id": "uuid-do-qrcode",
      "originalUrl": "https://github.com",
      "qrCodeUrl": "http://localhost:3002/qrcodes/uuid-do-qrcode/image",
      "createdAt": "2026-05-28T16:00:00.000Z"
    }
  ],
  "pagination": {
    "total": 1,
    "page": 1,
    "limit": 20,
    "pages": 1
  }
}

DELETE /v1/qrcodes/:id

Deleta um QR Code no banco de dados e remove permanentemente a imagem correspondente no Cloudinary.

Cabeçalho de Autenticação Requerido

Authorization: qr_token_obtido_no_cadastro  (ou: Bearer qr_token_...)

Retorno esperado

Status 204 No Content

QR Code Service API

Rotas Disponíveis