Documentación de la API

Inicio rápido

La API de QR Cake te permite gestionar los códigos QR de tu cuenta.

Autenticación

Crea una clave API en tu panel y envíala en el encabezado Authorization.

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

Gestiona las claves API en Claves API del panel.

Probador de solicitudes API

Prueba los endpoints directamente desde esta página. Introduce tu clave API, elige un endpoint y revisa la respuesta en tiempo real.

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

Terminología

Cuerpos de solicitud (POST/PUT)

Para las solicitudes POST y PUT, los cuerpos de la solicitud deben serializarse como cadena. Si vas a enviar JSON, pasa una cadena JSON (por ejemplo 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": {}
}

Productos = códigos QR.

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

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

{
  "message": {}
}

El cuerpo de la solicitud POST debe enviarse serializado (por ejemplo, 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": {}
}

El cuerpo de la solicitud PUT debe enviarse serializado.

Tipos de QR admitidos

Usa estos tipos de metadatos al crear o actualizar códigos QR.

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

Empieza con códigos QR dinámicos y códigos QR editables en nuestra página principal.