Файли

API GetQR перебуває в бета-версії та доступний для окремих робочих просторів. До загального релізу деталі можуть змінитися.

QR-коди PDF, Image і Video ведуть на файл, і власний логотип — теж файл. Завантаження відбувається у два кроки: зареєструйте файл, щоб отримати URL, а потім надішліть байти на цей URL.

Метод	Шлях	Опис
`POST`	`/api/v1/files`	Реєстрація завантаження файлу

Завантаження файлу

Зареєструйте файл

Викличте Реєстрацію завантаження файлу з target, contentType і size файлу. target визначає допустимі типи вмісту й обмеження розміру. Ви отримаєте fileId і uploadUrl.

Надішліть файл

Надішліть файл запитом PUT на uploadUrl. Його Content-Type і Content-Length мають точно збігатися із зареєстрованими contentType і size: усе інше відхиляється. URL попередньо підписаний, тому не додавайте свій API-ключ. Термін його дії — 10 хвилин.

curl -X PUT "$UPLOAD_URL" \
  -H "Content-Type: application/pdf" \
  --data-binary @menu.pdf

Використайте ID файлу

Передайте fileId, коли створюєте QR-код:

Як fileId для QR-коду pdf, image або video. Завантажуйте з відповідним target.
Як fileId для зображення профілю QR-коду vcard, social, multilink або event. Завантажуйте з target logo.
Як logoOptions.fileId, з logoOptions.type зі значенням uploaded, для власного логотипа. Завантажуйте з target logo. Див. Оформлення.

Обмеження

`target`	Допустимі типи вмісту	Максимальний розмір
`pdf`	`application/pdf`	20 МБ (20 971 520 байтів)
`image`	`image/*`	5 МБ (5 242 880 байтів)
`video`	`video/*`	50 МБ (52 428 800 байтів)
`logo`	`image/*`	5 МБ (5 242 880 байтів)

Лише MIME-тип. Надсилайте один тип і підтип у нижньому регістрі, наприклад image/png. Параметри на кшталт ;charset= і списки відхиляються.
Без SVG. Типи на основі XML, як-от image/svg+xml, не приймаються. Завантажуйте растрове зображення, наприклад image/png або image/jpeg.

Заголовки

string

обов'язково

Bearer, а за ним ваш API-ключ. Див. Автентифікація.

string

обов'язково

application/json.

Реєстрація завантаження файлу

POST /api/v1/files Реєструє файл і повертає попередньо підписаний URL для його завантаження. Сам файл цей виклик не завантажує.

string

обов'язково

Для чого файл: pdf, image, video або logo. Визначає допустимі типи вмісту й обмеження розміру. Див. Обмеження.

string

обов'язково

MIME-тип файлу, наприклад application/pdf, без параметрів. Запит на завантаження має надіслати саме цей Content-Type.

integer

обов'язково

Точний розмір файлу в байтах, додатне ціле число. Перевіряється за обмеженням для target. Запит на завантаження має надіслати саме цей Content-Length.

string

Початкова назва файлу, до 255 символів. Зберігається для відображення в панелі керування. Шлях із / або \ відхиляється.

string

ID, який потрібно передати як fileId або logoOptions.fileId.

string

Попередньо підписаний URL, на який потрібно надіслати файл через PUT.

integer

Кількість секунд до завершення дії uploadUrl: 600.

string

Метод HTTP для завантаження: PUT.

curl -X POST "https://getqr.com/api/v1/files" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "target": "pdf",
    "contentType": "application/pdf",
    "size": 248000,
    "name": "menu.pdf"
  }'

{
  "fileId": "file_7bQ2xR9mKp",
  "uploadUrl": "https://storage.getqr.com/qrs-content/pdf/file_7bQ2xR9mKp?X-Amz-...",
  "expiresIn": 600,
  "method": "PUT"
}

Поширені проблеми

422 "Content type … is not allowed for target"

Тип вмісту не відповідає target. Наприклад, pdf приймає лише application/pdf. Див. Обмеження.

422 "must be a single lowercase type/subtype"

Надсилайте тип вмісту в нижньому регістрі й без параметрів: image/png, а не Image/PNG чи image/png; charset=utf-8.

422 "File is too large for target"

Заявлений size перевищує обмеження для target. Стисніть файл, перш ніж реєструвати його.

Не вдається завантажити файл на uploadUrl

Дія URL завершується через 10 хвилин після реєстрації файлу, а запит має надіслати саме зареєстровані Content-Type і Content-Length. Зареєструйте файл знову, щоб отримати новий URL.

422 "is registered but its content was never uploaded" під час створення QR-коду

Ви зареєстрували файл, але PUT на uploadUrl не завершився. Завантажте файл, а потім створіть QR-код.

422 "was uploaded to …" під час створення QR-коду

Файл зареєстровано з іншим target, наприклад файл image використано для QR-коду pdf. Зареєструйте нове завантаження з відповідним target.

404 "File … was not found" під час створення QR-коду

fileId не існує. Візьміть його з відповіді Реєстрації завантаження файлу.

API

Завантаження файлу

Обмеження

Заголовки

Реєстрація завантаження файлу

Поширені проблеми

Що далі

QR-коди

Дані QR-коду за типами

Оформлення

Помилки

​Завантаження файлу

​Обмеження

​Заголовки

​Реєстрація завантаження файлу

​Поширені проблеми

​Що далі

QR-коди

Дані QR-коду за типами

Оформлення

Помилки

Завантаження файлу

Обмеження

Заголовки

Реєстрація завантаження файлу

Поширені проблеми

Що далі