mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
SnapOtterandGitHub
4963ab3bbd
All 181 docs markdown files translated into 20 languages (apps/docs/<locale>/**). Companion to the i18n code PR; admin-merged because the file count exceeds GitHub's per-PR CI trigger limit. Validated by pnpm i18n:check (all surfaces, 0 stale/missing) and a clean all-locale docs build.
77 lines
4.6 KiB
Markdown
77 lines
4.6 KiB
Markdown
---
|
|
description: "Генеруйте QR-коди з власними кольорами та рівнями корекції помилок."
|
|
i18n_source_hash: 096ef4d90da5
|
|
i18n_provenance: human
|
|
i18n_output_hash: 1aa8cbe5b0df
|
|
---
|
|
|
|
# Генератор QR-кодів {#qr-code-generator}
|
|
|
|
Генеруйте зображення QR-кодів із тексту або URL з налаштовуваним розміром, рівнем корекції помилок та власними кольорами переднього плану/фону.
|
|
|
|
## Кінцева точка API {#api-endpoint}
|
|
|
|
`POST /api/v1/tools/image/qr-generate`
|
|
|
|
Приймає **тіло JSON** (не multipart). Завантаження файлу не потрібне.
|
|
|
|
## Параметри {#parameters}
|
|
|
|
| Параметр | Тип | Обов'язковий | За замовчуванням | Опис |
|
|
|-----------|------|----------|---------|-------------|
|
|
| text | string | Так | - | Вміст для кодування в QR-коді (від 1 до 2000 символів) |
|
|
| size | number | Ні | `400` | Ширина/висота вихідного зображення в пікселях (від 100 до 10000) |
|
|
| errorCorrection | string | Ні | `"M"` | Рівень корекції помилок: `L` (7%), `M` (15%), `Q` (25%), `H` (30%) |
|
|
| foreground | string | Ні | `"#000000"` | Колір переднього плану/модуля QR-коду в hex (`#RRGGBB`) |
|
|
| background | string | Ні | `"#FFFFFF"` | Колір фону QR-коду в hex (`#RRGGBB`) |
|
|
| logoDataUri | string | Ні | - | Зображення логотипа як data URI (`data:image/png;base64,...` або `data:image/jpeg;base64,...`, максимум 700 КБ). Розміщується по центру QR-коду на 22% від розміру QR. Примусово встановлює корекцію помилок на `H` |
|
|
|
|
### Рівні корекції помилок {#error-correction-levels}
|
|
|
|
| Рівень | Відновлення | Випадок використання |
|
|
|-------|----------|----------|
|
|
| `L` | ~7% | Максимальна щільність даних |
|
|
| `M` | ~15% | Збалансований (за замовчуванням) |
|
|
| `Q` | ~25% | Добре для друкованих кодів |
|
|
| `H` | ~30% | Найкраще для кодів із накладенням логотипа |
|
|
|
|
## Приклад запиту {#example-request}
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/image/qr-generate \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-H "Content-Type: application/json" \
|
|
-d '{"text": "https://snapotter.com", "size": 500, "errorCorrection": "H"}'
|
|
```
|
|
|
|
Брендований QR-код із власними кольорами:
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/image/qr-generate \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-H "Content-Type: application/json" \
|
|
-d '{"text": "Hello World", "size": 300, "foreground": "#1a365d", "background": "#f7fafc"}'
|
|
```
|
|
|
|
## Приклад відповіді {#example-response}
|
|
|
|
```json
|
|
{
|
|
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/qrcode.png",
|
|
"originalSize": 0,
|
|
"processedSize": 4520
|
|
}
|
|
```
|
|
|
|
## Примітки {#notes}
|
|
|
|
- Ця кінцева точка приймає JSON, а не дані форми multipart, оскільки завантаження зображення не потрібне.
|
|
- Вихідне зображення завжди у форматі PNG.
|
|
- Ім'я вихідного файлу завжди `qrcode.png`.
|
|
- `originalSize` завжди дорівнює 0, оскільки цей інструмент генерує зображення з нуля.
|
|
- Навколо QR-коду включено тиху зону (поле) у 2 модулі.
|
|
- Максимальна довжина тексту становить 2000 символів. Фактична місткість залежить від рівня корекції помилок та кодування символів.
|
|
- Вищі рівні корекції помилок дозволяють QR-коду залишатися придатним для сканування навіть за часткового перекриття, але зменшують місткість даних.
|
|
- Коли вказано `logoDataUri`, корекція помилок автоматично примусово встановлюється на `H` (30%), щоб QR-код залишався придатним для сканування, незважаючи на те, що логотип закриває центр.
|