Documentació de l'API

Inici ràpid

L'API de QR Cake permet als usuaris de QR Cake gestionar els seus codis QR.

Autenticació

Crea una clau d'API al teu tauler i envia-la a la capçalera Authorization.

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

Gestiona les claus d'API Claus d'API del tauler.

Provador de sol·licituds API

Prova els punts finals directament des d'aquesta pàgina. Introdueix la teva clau d'API, selecciona un punt final i inspecciona la resposta en directe.

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

Terminologia

Cossos de la sol·licitud (POST/PUT)

Per a les sol·licituds POST i PUT, els cossos de la sol·licitud han de ser cadenes. Si envies JSON, passa una cadena JSON (per exemple 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": {}
}

Productes = codis 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 cos de la sol·licitud POST ha de ser una cadena (per exemple, 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 cos de la sol·licitud PUT ha de ser una cadena.

Tipus de QR compatibles

Fes servir aquests tipus de metadades quan creïs o actualitzis productes QR.

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

Comença amb codis QR dinàmics i codis QR canviables a la nostra pàgina d'inici.