API dokumentáció

Gyors kezdés

A QR Cake API lehetővé teszi a QR Cake felhasználók számára, hogy programozottan kezeljék a QR-kódjaikat.

Hitelesítés

Hozz létre egy API kulcsot az irányítópulton, és küldd el az Authorization fejlécben.

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

API kulcs kezelése Irányítópult API kulcsok.

API kérés-tesztelő

Teszteld a végpontokat közvetlenül erről az oldalról. Írd be az API kulcsod, válassz egy végpontot, és ellenőrizd az élő választ.

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

Terminológia

Kérés-törzsek (POST/PUT)

A POST és a PUT kérések esetében a kérés törzsét sztringként kell átadni. Ha JSON-t küldesz, adj át egy JSON-sztringet (például 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": {}
}

A termékek = QR-kódok.

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

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

{
  "message": {}
}

A POST kérés törzsét sztringként kell átadni (például 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": {}
}

A PUT kérés törzsét sztringként kell átadni.

Támogatott QR-típusok

Használd ezeket a metaadattípusokat QR-termékek létrehozásakor vagy frissítésekor.

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

Kezdje ezzel: dinamikus QR-kódok és cserélhető QR-kódok a honlapunkon.