Dokumentácia API pre dynamické QR kódy | QR Cake

Rýchly štart

API QR Cake umožňuje používateľom QR Cake spravovať svoje QR kódy v účte.

Autentifikácia

Vytvorte si kľúč API vo svojom hlavnom paneli a odošlite ho v hlavičke x-api-key.

x-api-key: <API Key>
Content-Type: application/json

Spravujte kľúče API v Kľúče API v hlavnom paneli.

Tester API požiadaviek

Testujte koncové body priamo z tejto stránky. Zadajte svoj kľúč API, vyberte koncový bod a skontrolujte aktuálnu odpoveď.

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

Terminológia

Telá požiadaviek (POST/PUT)

V prípade požiadaviek POST a PUT musia byť telá požiadaviek odovzdané ako reťazec (stringified). Ak odosielate JSON, odovzdajte reťazec JSON (napríklad 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": {}
}

Produkty = QR kódy.

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

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

{
  "message": {}
}

Telo požiadavky POST musí byť odovzdané ako reťazec (napríklad 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": {}
}

Telo požiadavky PUT musí byť odovzdané ako reťazec.

Podporované typy QR

Tieto typy metadát použite pri vytváraní alebo aktualizácii produktov QR.

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

Začnite s dynamickými QR kódmi a meniteľnými QR kódmi na našej domovskej stránke.