Documentație API

Pornire rapidă

QR Cake API permite utilizatorilor QR Cake să își gestioneze contul QR Codes.

Autentificare

Creați o cheie API în tabloul de bord și trimiteți-o în antetul Autorizare.

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

Gestionați API chei Tabloul de bord API Taste.

API Solicitați tester

Testați punctele finale direct de pe această pagină. Introduceți cheia API, selectați un punct final și inspectați răspunsul în direct.

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

Terminologie

Organisme de solicitare (POST/PUT)

Pentru solicitările POST și PUT, organismele de solicitare trebuie să fie stringificate. Dacă trimiteți JSON, transmiteți un șir JSON (de exemplu 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": {}
}

Produse = 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": {}
}

POST corpul solicitării trebuie să fie stringificat (de exemplu, 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": {}
}

PUT corpul solicitării trebuie să fie stringificat.

Tipuri QR acceptate

Utilizați aceste tipuri de metadate atunci când creați sau actualizați produse QR.

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

Începeți cu coduri QR dinamice şi coduri QR schimbabile pe pagina noastră principală.