SOROKA Документация API

Журнал изменений

Политика версий

Изменения

  1. Вебхуки подписок: заголовки X-Webhook-Subscription, X-Webhook-Delivery, X-Webhook-Timestamp, X-Webhook-Signature, User-Agent: webhooks/1.0. Дубли отсеивайте по id событий: повтор после неудачи может прийти с другим delivery_id. Idempotency-Key у создания задачи и подписки — рекомендуется. Ошибки /v1/webhooks: fields — список {loc, msg}. На странице ошибок — коды bad_ref, too_many_chats, bad_cursor, bad_idempotency_key, subscription_ended, subscription_not_active.
  2. Вебхуки подписок: редакциям прежние заголовки X-Soroka-* и User-Agent: soroka-webhook приходят вместе с новыми X-Webhook-*. Бизнесу — без меток аккаунтов: нет account и X-Soroka-Account, group_by=account в учёте — только редакциям.
  3. Вебхуки событий организации: право webhooks, пути /v1/webhooks (адреса, тестовое событие, журнал доставок, повтор), события task.done, task.partial, task.failed, quota.threshold, invoice.issued, monitor.hit, key.expiring; заголовки X-Webhook-*. Новые code: unknown_event, webhook_limit, webhook_disabled.
  4. Документация /docs. В /v1/openapi.json — описания путей; ошибки разбора тела описаны как 400 с телом ошибки API (FastAPI-шных 422 нет и раньше не было).
  5. Тарифы и кредиты: ошибка 402 payment_required с кодами credits_exhausted, trial_ended, read_only, subscription_cancelled, no_subscription, not_in_plan, plan_limit; оценка задачи POST /v1/jobs/estimate; тариф и остаток в GET /v1/me (billing); списанные кредиты задачи в result_summary.credits.
  6. Лимит в минуту считается по календарной минуте UTC; X-RateLimit-Reset — секунд до начала следующей минуты.
  7. Выдача без авторов-людей для бизнес-организаций; проверенным — author_hash вместо автора. Право сверх потолка организации — 403 auth_failed, code=edition_forbidden.
  8. POST /v1/tg/resolve: сначала наш каталог (поле ответа source), fresh: true — мимо каталога.
  9. Данные о людях — отдельными правами tg:people и vk:people.
  10. Задачи /v1/jobs: список с фильтром status, progress.percent, отмена, файл результата json/csv/xlsx. ВКонтакте: коды ошибок vk_<номер>, пачка методов /v1/vk/batch.
  11. Контракт v1: единая форма ошибок, курсорная пагинация, Idempotency-Key, подписки на события с доставкой потоком, страницами и вебхуком с подписью.
  12. Белый список методов /v1/tg/call, аренды под чат, брокер прокси.