HW agent API 2.14.1
Справка OpenAPI English hw-connector.ru

Раздел API

Сканеры документов

Сканеры документов WIA и TWAIN: скан в PDF или JPEG по странице, файлы результата и их удаление. Нужен модуль «Сканер документов» в ключе (кроме эмулятора).

POST/api/v1/document-scanners/scanОтсканировать
GET/api/v1/scans/{id}/{file}Файл результата сканирования
GET/api/v1/document-scannersСканеры документов
DELETE/api/v1/scans/{id}Удалить результат сканирования

Отсканировать#

POST/api/v1/document-scanners/scan
Операция

Операция document-scan; result — id и ссылки на файлы (PDF одним файлом или JPEG по странице), скачивание — GET /api/v1/scans/{id}/{файл}. Без ключа модуля — 402 LICENSE_REQUIRED (кроме device: emulator). Удобно с Prefer: wait=120 — ответ придёт, когда сканер закончит

Параметры

ИмяГдеТипОписание
Idempotency-Keyобязательныйheaderstring
Preferheaderstring

Тело запроса application/json

Поля · ScanSettings
  • devicestring
  • sourcestring
  • dpiinteger int32
    от 50
    до 1200
  • colorstring
  • formatstring
  • pageSizestring
  • widthMmnumber double
    от 10
    до 1000
  • heightMmnumber double
    от 10
    до 1000
  • brightnessinteger int32
    от -1000
    до 1000
  • contrastinteger int32
    от -1000
    до 1000
  • qualityinteger int32
    от 10
    до 100
  • maxPagesinteger int32
    от 1
    до 500
JSON
{
  "device": "string",
  "source": "string",
  "dpi": 50,
  "color": "string",
  "format": "string",
  "pageSize": "string",
  "widthMm": 10,
  "heightMm": 10,
  "brightness": -1000,
  "contrast": -1000,
  "quality": 10,
  "maxPages": 1
}

Ответ 200 application/json

Поля · Operation
  • idstring uuid
  • typestring
  • idempotencyKeystring
  • resourcesмассив string
  • statusstring
    значения: QUEUED RUNNING SUCCEEDED FAILED UNKNOWN
  • stagestring
  • createdAtstring date-time
  • startedAtstring date-time
  • finishedAtstring date-time
  • resultлюбое значение
  • errorOperationError
    3 поля · OperationError
    • codestring
    • messagestring
    • detailsлюбое значение
  • warningsмассив string

Ошибки — problem+json с полем code, см. коды ошибок.

Пример запроса

curl
curl -X POST 'http://localhost:7790/api/v1/document-scanners/scan' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30' \
  -H 'Content-Type: application/json' \
  --data '{"device":"string","source":"string","dpi":50,"color":"string","format":"string","pageSize":"string","widthMm":10,"heightMm":10,"brightness":-1000,"contrast":-1000,"quality":10,"maxPages":1}'
curl
curl -X POST 'https://cloud.hw-connector.ru/agent/api/v1/document-scanners/scan' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30' \
  -H 'Content-Type: application/json' \
  --data '{"device":"string","source":"string","dpi":50,"color":"string","format":"string","pageSize":"string","widthMm":10,"heightMm":10,"brightness":-1000,"contrast":-1000,"quality":10,"maxPages":1}'

Файл результата сканирования#

GET/api/v1/scans/{id}/{file}

Имя файла — из result.files операции: scan.pdf, page-1.jpg…

Параметры

ИмяГдеТипОписание
idобязательныйpathstring uuid
fileобязательныйpathstring

Ответ 200

Файл.

Ошибки — problem+json с полем code, см. коды ошибок.

Пример запроса

curl
curl 'http://localhost:7790/api/v1/scans/3f6c1d9e-1b2a-4c55-9e0d-6a1f0c2b7d11/scan.pdf'
curl
curl 'https://cloud.hw-connector.ru/agent/api/v1/scans/3f6c1d9e-1b2a-4c55-9e0d-6a1f0c2b7d11/scan.pdf' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42'

Сканеры документов#

GET/api/v1/document-scanners

WIA — все сканеры и МФУ с драйвером Windows, TWAIN — если установлена NAPS2, и эмулятор. Агент подключается к каждому сканеру, ответ — до нескольких секунд

Ответ 200 application/json

Поля · ScannerList
  • licensedboolean
  • scannersмассив ScannerInfo
    5 полей · ScannerInfo
    • idstring
    • driverstring
    • namestring
    • manufacturerstring
    • sourcesмассив string

Ошибки — problem+json с полем code, см. коды ошибок.

Пример запроса

curl
curl 'http://localhost:7790/api/v1/document-scanners'
curl
curl 'https://cloud.hw-connector.ru/agent/api/v1/document-scanners' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42'

Удалить результат сканирования#

DELETE/api/v1/scans/{id}

Сразу, не дожидаясь срока хранения (hw.document-scanner.keep-hours)

Параметры

ИмяГдеТипОписание
idобязательныйpathstring uuid

Ответ 200

Без тела.

Ошибки — problem+json с полем code, см. коды ошибок.

Пример запроса

curl
curl -X DELETE 'http://localhost:7790/api/v1/scans/3f6c1d9e-1b2a-4c55-9e0d-6a1f0c2b7d11'
curl
curl -X DELETE 'https://cloud.hw-connector.ru/agent/api/v1/scans/3f6c1d9e-1b2a-4c55-9e0d-6a1f0c2b7d11' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42'