Dokumentace API

Zdroje a návody pro vývojáře k integraci QR Cake .

JSON REST APIDynamická tvorba QRBearer Autorizace

Vytvořit klíč API

Rychlý start

QR Cake API umožňuje QR Cake uživatelům spravovat jejich účet QR Codes.

Základ URL

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

Koncové body

Seznam QR CodesGET

/user/product

Získejte QR kódGET

/product/{productId}

Vytvořte QR kódPOST

/product

Aktualizujte 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 Ovládací panel API Klávesy.

API Vyžádejte si tester

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 <API Key>

Vyřešeno 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 Codes

Uživatelé

QR Cake účtů

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

U požadavků POST a PUT musí být těla požadavků stringována. 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 Codes

Uvádí seznam QR Codes přístupných klíči API.

Otevřete v GitBook

Cesta: /user/product

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

Vyžádejte si podrobnosti

Záhlaví

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 Codes.

GET

Získejte 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}

Vyžádejte si podrobnosti

Parametry cesty

productId (string)

Záhlaví

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řte QR kód

Vytvoří nový produkt QR Code.

Otevřete v GitBook

Cesta: /product

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

Vyžádejte si podrobnosti

Záhlaví

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 požadavku POST musí být stringified (například JSON.stringify(payload)).

PUT

Aktualizujte QR kód

Aktualizuje stávající QR kód (produkt).

Otevřete v GitBook

Cesta: /product/{productId}

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

Vyžádejte si podrobnosti

Parametry cesty

productId (string)

Záhlaví

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

PUT tělo požadavku musí být stringified.

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}

Vyžádejte si podrobnosti

Parametry cesty

productId (string)

Záhlaví

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

Vyžádejte si podrobnosti

Záhlaví

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 produktů QR.

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

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