Documentație API

Pornire rapidă

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

Autentificare

Creează o cheie API în panoul de control și trimite-o în antetul Authorization.

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

Gestionează cheile API în Cheile API din panou.

Tester pentru cereri API

Testează endpoint-urile direct de pe această pagină. Introdu cheia API, alege un endpoint și inspectează răspunsul live.

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

Terminologie

Corpul cererilor (POST/PUT)

Pentru cererile POST și PUT, corpul cererii trebuie să fie un șir. 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": {}
}

Products = Coduri QR.

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

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

{
  "message": {}
}

Corpul cererii POST 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": {}
}

Corpul cererii PUT trebuie să fie stringificat.

Tipuri QR acceptate

Folosește aceste tipuri de metadate atunci când creezi sau actualizezi produsele QR.

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

Începe cu codurile QR dinamice și codurile QR modificabile pe pagina noastră principală.