Dokumentace API pro dynamické QR kódy | QR Cake

Vytvářejte, aktualizujte a spravujte dynamické QR kódy pomocí QR Cake API. Používejte API klíče, testujte požadavky a propojte QR workflow s vlastními nástroji.

JSON REST APIDynamická tvorba QRAutorizace Bearer

Rychlý start

QR Cake API umožňuje uživatelům QR Cake spravovat QR kódy jejich účtu.

Základní URL

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

Koncové body

Seznam QR kódůGET

/user/product

Načíst QR kódGET

/product/{productId}

Vytvořit QR kódPOST

/product

Aktualizovat QR kódPUT

/product/{productId}

Smazat QR kódDELETE

/product/{productId}

OprávněníGET

/permission

Autentizace

Vytvořte klíč API na řídicím panelu a odešlete jej v záhlaví Autorizace.

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

Spravovat klíče API API klíče v panelu.

Tester API

Otestujte koncové body přímo z této stránky. Zadejte svůj klíč API, vyberte koncový bod a zkontrolujte živou odpověď.

Interaktivní tester API

Spouštějte požadavky přímo z vašeho prohlížeče do vybraného koncového bodu QR Cake API.

GET

Koncový bod

Klíč API

Authorization: Bearer YOUR_API_KEY

Výsledná URL

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

Spusťte požadavek, abyste zde viděli živý stav a výstup odpovědi.

Terminologie

Produkty

QR kódy

Uživatelé

účty QR Cake

Těla požadavků (POST/PUT)

U požadavků POST a PUT musí být těla ve formě řetězce. Pokud odesíláte JSON, předejte řetězec JSON (např. JSON.stringify(payload)).

const payload = { redirect: "https://example.com", metadata: {} };

await fetch(url, {
  method: "POST",
  body: JSON.stringify(payload),
});

GET

Seznam QR kódů

Vypíše QR kódy přístupné pro daný klíč API.

Otevřete v GitBook

Cesta: /user/product

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

Podrobnosti požadavku

Hlavičky

Authorization: Bearer <API Key>
Accept: application/json

Odezvy

200 OK

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

401 Unauthorized

{
  "message": {}
}

Produkty = QR kódy.

GET

Načíst QR kód

Načte jeden QR kód.

Otevřete v GitBook

Cesta: /product/{productId}

URL: https://api.qrcake.com/v1/product/product/{productId}

Podrobnosti požadavku

Parametry cesty

productId (string)

Hlavičky

Authorization: Bearer <API Key>
Accept: application/json

Odezvy

200 OK

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

401 Unauthorized

{
  "message": {}
}

POST

Vytvořit QR kód

Vytvoří nový produkt typu QR kód.

Otevřete v GitBook

Cesta: /product

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

Podrobnosti požadavku

Hlavičky

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

Šablona těla

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

Odezvy

200 OK

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

401 Unauthorized

{
  "message": {}
}

Tělo POST požadavku musí být ve formě řetězce (například JSON.stringify(payload)).

PUT

Aktualizovat QR kód

Aktualizuje existující QR kód (produkt).

Otevřete v GitBook

Cesta: /product/{productId}

URL: https://api.qrcake.com/v1/product/product/{productId}

Podrobnosti požadavku

Parametry cesty

productId (string)

Hlavičky

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

Šablona těla

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

Odezvy

200 OK

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

401 Unauthorized

{
  "message": {}
}

Tělo PUT požadavku musí být ve formě řetězce.

DELETE

Smazat QR kód

Smaže QR kód.

Otevřete v GitBook

Cesta: /product/{productId}

URL: https://api.qrcake.com/v1/product/product/{productId}

Podrobnosti požadavku

Parametry cesty

productId (string)

Hlavičky

Authorization: Bearer <API Key>
Accept: application/json

Odezvy

200 OK

{
  "productId": "string"
}

401 Unauthorized

{
  "message": {}
}

GET

Oprávnění

Vrátí oprávnění udělená klíči API.

Otevřete v GitBook

Cesta: /permission

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

Podrobnosti požadavku

Hlavičky

Authorization: Bearer <API Key>
Accept: application/json

Odezvy

200 OK

{
  "success": true,
  "result": {
    "analytics": true,
    "productLimit": 100,
    "tier": "subscriber",
    "productTotal": 3,
    "productActiveLimit": 100,
    "productActiveTotal": 3
  }
}

401 Unauthorized

{
  "message": {}
}

Podporované typy QR

Tyto typy metadat použijte při vytváření nebo aktualizaci QR produktů.

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

Začněte s dynamickými QR kódy a vyměnitelnými QR kódy na naší domovské stránce.