API документи

Бърз старт

API-то на QR Cake позволява на потребителите на QR Cake да управляват QR кодовете в своя акаунт.

Удостоверяване

Създайте API ключ в таблото си и го изпратете в заглавката Authorization.

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

Управлявайте API ключовете в API ключове в таблото.

Тестер на API заявки

Тествайте ендпойнтите директно от тази страница. Въведете API ключа си, изберете ендпойнт и прегледайте отговора в реално време.

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

Терминология

Тела на заявки (POST/PUT)

За POST и PUT заявки тялото трябва да бъде stringified. Ако изпращате 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": {}
}

Продукти = 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 заявката трябва да бъде stringified (например 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 заявката трябва да бъде stringified.

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

Използвайте тези типове метаданни при създаване или актуализиране на QR продукти.

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

Започнете с динамични QR кодове и сменяеми QR кодове на нашата начална страница.