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

Используйте ключ доступа организации. Этот ключ также открывает кабинет. Вы получаете его при подключении. Передавайте ключ в заголовке Authorization: Bearer <ключ>. API не требует отдельного входа или cookies.

1. Проверьте ключ запросом GET /me. Этот запрос не запускает проверку документов.
2. Получите лимиты организации через GET /limits.
3. Отправьте файлы одного комплекта через POST /runs.
4. Сохраните run_id из ответа. Это идентификатор принятой проверки.
5. Запрашивайте GET /runs/{run_id} раз в 5 секунд до статуса done или failed.
6. Если status равен failed, прочитайте error и refunded.
7. Если status равен done, получите замечания через GET /runs/{run_id}/findings.
8. Скачайте отчёт через GET /runs/{run_id}/report.pdf.

export NK_BASE="https://xn--80atfddcbol.xn--p1ai/api/v1"
export NK_KEY="ВАШ_КЛЮЧ_ДОСТУПА"

curl --fail-with-body "$NK_BASE/me" \
  -H "Authorization: Bearer $NK_KEY"
curl --fail-with-body "$NK_BASE/limits" \
  -H "Authorization: Bearer $NK_KEY"

Замените ВАШ_КЛЮЧ_ДОСТУПА своим ключом. Примеры содержат вымышленные числа, организации и идентификаторы. В рабочих запросах используйте значения из ответов своего API.

$env:NK_KEY = "ВАШ_КЛЮЧ_ДОСТУПА"
$base = "https://xn--80atfddcbol.xn--p1ai/api/v1"
$headers = @{ Authorization = "Bearer $env:NK_KEY" }
Invoke-RestMethod -Uri "$base/me" -Headers $headers
Invoke-RestMethod -Uri "$base/limits" -Headers $headers

На странице «Обзор API» доступны программы check.py и check.ps1. Они загружают комплект и сохраняют run_id. После проверки программы скачивают JSON, Markdown, общий PDF и доступные PDF по разделам. Скачайте программу в рабочую папку. Задайте свой ключ в NK_KEY.

python -m pip install httpx
python check.py AR.pdf EOM.pdf --idempotency-key object-001-v1

# Продолжить получение уже принятой проверки без новой загрузки:
python check.py --run-id 9f1c3b7a-2d4e-4c8b-9a1f-6e5d4c3b2a10

.\check.ps1 -Files .\AR.pdf,.\EOM.pdf -IdempotencyKey object-001-v1

# Продолжить получение результата:
.\check.ps1 -RunId 9f1c3b7a-2d4e-4c8b-9a1f-6e5d4c3b2a10