Documentação da API

Início rápido

A API do QR Cake permite que os usuários do QR Cake gerenciem os QR codes da conta.

Autenticação

Crie uma chave de API no seu painel e envie-a no cabeçalho Authorization.

Authorization: Bearer <API Key>
Content-Type: application/json

Gerencie as chaves de API em Chaves de API no painel.

Testador de requisições da API

Teste endpoints diretamente nesta página. Informe sua chave de API, selecione um endpoint e inspecione a resposta em tempo real.

https://api.qrcake.com/v1/product/user/product

Terminologia

Corpos da solicitação (POST/PUT)

Em requisições POST e PUT, o corpo da requisição deve ser serializado. Se você estiver enviando JSON, passe uma string JSON (por exemplo JSON.stringify(payload)).

const payload = { redirect: "https://example.com", metadata: {} };

await fetch(url, {
  method: "POST",
  body: JSON.stringify(payload),
});

[
  {
    "accountId": "string",
    "productId": "string",
    "userId": "string",
    "redirect": "string",
    "state": "ACTIVE",
    "metadata": {},
    "createdAt": 0,
    "updatedAt": 0
  }
]

{
  "message": {}
}

Produtos = QR codes.

{
  "redirect": "https://example.com",
  "metadata": {},
  "state": "ACTIVE"
}

{
  "accountId": "string",
  "productId": "string",
  "userId": "string",
  "redirect": "string",
  "state": "ACTIVE",
  "metadata": {},
  "createdAt": 0,
  "updatedAt": 0
}

{
  "message": {}
}

O corpo da solicitação POST deve ser stringificado (por exemplo, JSON.stringify(payload)).

{
  "redirect": "https://example.com",
  "metadata": {},
  "state": "ACTIVE"
}

{
  "accountId": "string",
  "productId": "string",
  "userId": "string",
  "redirect": "string",
  "state": "ACTIVE",
  "metadata": {},
  "expiresAt": 0,
  "createdAt": 0,
  "updatedAt": 0
}

{
  "message": {}
}

O corpo da solicitação PUT deve ser stringificado.

Tipos de QR suportados

Use estes tipos de metadados ao criar ou atualizar produtos QR.

redirect, link, image, video, file, pdf, audio, app, event, vCard

Comece com QR codes dinâmicos e QR codes editáveis na nossa página inicial.