Разработчику

Документация API

Руководство по интеграции REST API динамических QR-кодов. Запросы и ответы — JSON.

Быстрый старт

Базовая информация для подключения

Base URL

https://qr-api.ru/v1

Версия

v1.0.0 Public Beta

Интерактивная спецификация (Swagger UI) доступна на /documentation бэкенда.

Эндпоинты

POST/qrcodes

Создаёт новый динамический QR-код. Цель можно менять позже — короткая ссылка остаётся.

Запрос

{
  "target_url": "https://yoursite.com",
  "type": "DYNAMIC",
  "design": { "fg": "hsl(262 83% 60%)", "dotStyle": "rounded" }
}

Ответ (200 OK)

{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "short_code": "x7yz9a",
    "target_url": "https://yoursite.com",
    "created_at": "2026-06-04T12:00:00Z"
  }
}

PATCH/qrcodes/{id}

Меняет цель редиректа или дизайн. Кэш редиректора обновляется автоматически.

Запрос

{ "target_url": "https://new-target.ru" }

Ответ (200 OK)

{ "success": true, "data": { "short_code": "x7yz9a", "target_url": "https://new-target.ru" } }

GET/analytics/{id}

Сводная статистика сканов по QR-коду (счётчики из Redis — мгновенно, без тяжёлых хранилищ).

Ответ (200 OK)

{
  "success": true,
  "data": {
    "total_scans": 150,
    "unique_visitors": 120,
    "scans_by_day": { "2026-06-01": 40, "2026-06-02": 55, "2026-06-03": 55 }
  }
}