Документация 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 тело запроса должно быть сериализовано в строку. Если вы отправляете 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-кодов на нашей главной странице.