API

REST API под BYOK-моделью: пользователь приносит свой OpenRouter-ключ, оплачивает Vision-токены напрямую провайдеру.

Полная схема и интерактивный try-it: /api/docs

1. Регистрация

curl -X POST https://ifrs.shidran.ru/api/auth/register \
  -H "Content-Type: application/json" \
  -d '{"email": "you@example.com", "password": "your-strong-password"}'

2. Personal Access Token

# В UI /settings создать Personal Access Token, затем:
export IFRS_TOKEN=ifp_...

3. Сохранить OpenRouter-ключ

curl -X PUT https://ifrs.shidran.ru/api/me/openrouter-key \
  -H "Authorization: Bearer $IFRS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"key": "sk-or-v1-..."}'

4. Загрузить PDF

Job создаётся со статусом queued, парсинг занимает ~30-90 сек.

curl -X POST https://ifrs.shidran.ru/api/jobs \
  -H "Authorization: Bearer $IFRS_TOKEN" \
  -F "pdf=@report.pdf" \
  -F "ticker=YDEX"
# → { "id": "...", "status": "queued", ... }

5. Опросить статус

curl https://ifrs.shidran.ru/api/jobs/$JOB_ID \
  -H "Authorization: Bearer $IFRS_TOKEN"
# → status: queued → running → succeeded

6. Скачать результаты

curl -O -J https://ifrs.shidran.ru/api/jobs/$JOB_ID/csv \
  -H "Authorization: Bearer $IFRS_TOKEN"
curl -O -J https://ifrs.shidran.ru/api/jobs/$JOB_ID/xlsx \
  -H "Authorization: Bearer $IFRS_TOKEN"

Лимиты

  • Размер PDF — до 50 MB.
  • Один пользователь — до 3 одновременных jobs.
  • Регистрация — 5 в час с одного IP.

Schema

CSV-колонки: ticker, statement, line_item_raw, concept_key, concept_key_vision, confidence, source, flags, period, value, note_ref. Подробнее — в OpenAPI.