Сканування через API

API перетворює PDF на реалістичну скан-копію за допомогою REST-запиту — для автоматизації та інтеграції із застосунками. Створіть завдання, завантажте PDF, а потім перевіряйте стан або чекайте на вебхук. Усього три кроки з будь-якого середовища чи мови, що підтримує HTTP-запити. Можна налаштувати колірний простір, роздільність, поворот, розмиття, шум, яскравість, контрастність і рамки.

Як працює виклик

  1. Створіть завдання

    POST /v1/scan-jobs

    Надішліть config і, за потреби, webhookUrl. У відповідь отримаєте jobID та підписану адресу uploadURL.

  2. Надішліть PDF

    PUT {uploadURL}

    Надішліть файл запитом PUT безпосередньо на підписану адресу S3 з попереднього кроку. Токен не потрібен.

  3. Отримайте скан-копію

    GET /v1/scan-jobs/{jobID}

    Перевіряйте стан або дочекайтеся вебхука. Коли завдання матиме стан completed, збережіть результат за адресою downloadURL.

Де це стане в пригоді

Пакетна обробка на сервері

Договори, рахунки та звіти, створені на сервері, одразу отримують ефект сканування. Не потрібно щоразу запускати обробку вручну на сайті.

Інтеграція з наявною системою

Додайте дію «Експортувати скан-копію» до CRM, ERP або системи підтримки та підключіть її до API.

Автоматизовані процеси

CI, n8n, Zapier та інші інструменти запускають завдання за подією, а вебхук запускає наступний крок після завершення обробки.

Великі черги файлів

Завдання виконуються асинхронно: створіть їх, і кожне оброблятиметься окремо. Відстежуйте перебіг за допомогою status та createdAfter.

Мови й середовища

TypeScriptfetch / axios
Node.jsfetch / undici
Pythonrequests / httpx
Gonet/http
PHPcURL / Guzzle
Rubynet/http
JavaHttpClient
cURLКомандний рядок / CI
ІншіБудь-який HTTP-клієнт

API використовує звичайні HTTP та JSON. Його можна викликати з будь-якої мови чи платформи автоматизації, що вміє надсилати запити.

Приклади коду

API Bearer Token

Токен належить вашому обліковому запису. Його можна створити заново будь-коли. Для сканування через API потрібен Pro: без дійсного токена API повертає 401, а без ролі Pro — 403.

Спробувати

Налаштуйте параметри — тіло запиту оновлюватиметься одразу. Потім виконайте три виклики API.

Параметри сканування

Пробний запуск викликає API з вашим токеном і потребує Pro. Переглядати параметри й тіло запиту можна безкоштовно.

POST/v1/scan-jobs
{
  "config": {
    "rotate": 1,
    "rotate_var": 0.5,
    "colorspace": "gray",
    "blur": 0,
    "noise": 0,
    "border": false,
    "brightness": 1.3,
    "contrast": 1.3,
    "resolution": 150,
    "output_format": "image/jpeg"
  }
}

Відомості про завдання сканування

приклад
{
  "jobID": "3f9c1e64-0000-4000-8000-00000000a71b",
  "userID": "8f21c4b0-0000-4000-8000-000000004a17",
  "createdAt": 1724409600,
  "status": "completed",
  "inputUploadedAt": 1724409601,
  "completedAt": 1724409602,
  "numPages": 6,
  "downloadURL": "https://…/output/3f9c.pdf?X-Amz-…"
}

Довідник API

МетодШляхОпис
POST/v1/scan-jobsСтворення завдання сканування. Надішліть config і, за потреби, webhookUrl. У відповідь отримаєте об’єкт завдання зі станом created та підписаною адресою uploadURL.
PUT{uploadURL}Підписана адреса S3 з попереднього кроку, поза api.lookscanned.ioЗавантаження вихідного PDF із заголовками Content-Type: application/pdf і Content-Length. Адреса вже містить підпис, тому не додавайте заголовок Authorization.
GET/v1/scan-jobs/{jobID}Отримання окремого завдання для перевірки стану. У стані created воно містить uploadURL, а у стані completed — downloadURL.
GET/v1/scan-jobsСписок ваших завдань із фільтрацією за jobID, status або createdAfter.
Станcreatedprocessingcompletedfailed
  • 401 немає дійсного токена
  • 403 обліковий запис без Pro
  • 404 завдання не знайдено

Тіло запиту

ПолеТипЗа замовчуваннямОпис
webhookUrlstring · —Викликається один раз після завершення завдання, щоб не доводилося періодично перевіряти стан.
config.colorspace'gray' | 'sRGB' · graygrayКолірний простір вихідного зображення; gray — скан-копія у відтінках сірого.
config.resolutionnumber · 7272Роздільність вихідного зображення в DPI.
config.rotatenumber · —Поворот усього документа в градусах.
config.rotate_varnumber · —Діапазон випадкового повороту кожної сторінки в градусах — імітація нерівно покладеного аркуша.
config.blurnumber · 00Ступінь розмиття.
config.noisenumber · 00Рівень шуму.
config.brightnessnumber · 11Яскравість; 1 залишає її без змін.
config.contrastnumber · 11Контрастність; 1 залишає її без змін.
config.borderboolean · falsefalseЧи додавати рамку сканування до сторінки.
config.output_format'image/png' | 'image/jpeg' · image/jpegimage/jpegФормат зображень, у які перетворюються сторінки.

Усі поля необов’язкові. Початкові значення в розділі «Спробувати» — роздільність 150, поворот 1, яскравість і контрастність 1.3 — рекомендовані вебзастосунком, а не стандартні значення API.

Основні поля об’єкта завдання

status
created / processing / completed / failed — стан визначає наявність двох адрес нижче.
uploadURL
Лише в стані created. Підписана адреса для завантаження файлу з обмеженим строком дії.
downloadURL
Лише в стані completed. Підписана адреса для отримання результату з обмеженим строком дії.
inputUploadedAt / completedAt
Час завершення завантаження вихідного файлу й час завершення завдання. Різниця між ними — тривалість обробки.

Поширені запитання

Чи потрібен Pro для сканування через API?

Так. Без дійсного токена API повертає 401, а для облікового запису без ролі Pro — 403. Перейдіть на Pro та увійдіть: токен з’явиться на цій сторінці.

Як дізнатися, що завдання завершено?

Є два способи: періодично надсилати GET /v1/scan-jobs/{jobID} або передати webhookUrl під час створення завдання, щоб сервіс повідомив вас одним зворотним викликом.

Чи буде результат таким самим, як на сайті?

Так. Обидва способи використовують ту саму реалізацію ефекту сканування. Колірний простір, роздільність, поворот, розмиття, шум, яскравість, контрастність і рамка в config відповідають налаштуванням на сайті під іншими назвами. Однакові параметри дають однаковий результат. Відрізняється лише місце обробки: локально на сторінці або віддалено через API.

Чи можна зберегти адреси для завантаження й отримання файлів та використовувати їх повторно?

Не варто. uploadURL і downloadURL — підписані адреси з обмеженим строком дії. Коли він спливе, отримайте дані завдання ще раз, щоб мати нові адреси.

Скільки триває обробка?

Це залежить від кількості сторінок і роздільності. Кілька сторінок зазвичай обробляються за секунди. Вища роздільність і довші документи потребують більше часу. Фактична тривалість — різниця між inputUploadedAt та completedAt.

Що робити, якщо завдання завершилося помилкою?

Стан зміниться на failed. Зазвичай причина — некоректний PDF, обмеження шифрування або перерване завантаження. Перевірте, чи відкривається файл, і створіть нове завдання.

Чи можна переглянути попередні завдання?

Так. GET /v1/scan-jobs повертає список ваших завдань із фільтрацією за jobID, status та createdAfter. Цього достатньо для звірки або повторного збереження результату.