API документација

Брзи почетак

QR Cake API омогућава корисницима QR Cake-а да управљају QR кодовима свог налога.

Аутентификација

Направите API кључ на својој контролној табли и пошаљите га у заглављу x-api-key.

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

Управљајте API кључевима у API кључеви контролне табле.

API тестер захтева

Тестирајте крајње тачке директно са ове странице. Унесите свој API кључ, изаберите крајњу тачку и прегледајте одговор уживо.

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

Терминологија

Тела захтева (POST/PUT)

За POST и PUT захтеве, тела захтева морају бити серијализована у стринг. Ако шаљете JSON, проследите JSON стринг (на пример 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 = QR кодови.

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

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

{
  "message": {}
}

POST тело захтева мора бити серијализовано у стринг (на пример, 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": {}
}

PUT тело захтева мора бити серијализовано у стринг.

Подржани QR типови

Користите ове типове метаподатака када креирате или ажурирате QR производе.

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

Почните са динамичким QR кодовима и променљивим QR кодовима на нашој почетној страници.