Документація API для динамічних QR-кодів | QR Cake

Швидкий старт

QR Cake API дозволяє користувачам QR Cake керувати QR-кодами свого облікового запису.

Аутентифікація

Створіть ключ API на панелі керування та надішліть його у заголовку авторизації.

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

Керуйте ключами API в Ключі API на панелі керування.

Тестування API

Тестуйте кінцеві точки безпосередньо з цієї сторінки. Введіть свій ключ API, виберіть кінцеву точку та перевірте відповідь у реальному часі.

https://api.qrcake.com/v1/product/user/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": {}
}

Продукти = 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-кодів на нашій головній сторінці.