Справочник API
Справочник пользовательского API itd-api. В отличие от руководств, здесь нет больших сценариев — только доступные через клиент методы, их параметры, возвращаемые типы и основные вспомогательные функции.
Ресурсы клиента
| Категория | Доступ | О чём |
|---|---|---|
| Клиент | new ItdClient() | конструктор, request(), use(), сервисы, события, realtime(), close() |
| Авторизация | itd.auth | вход, регистрация, OTP, пароли, сессии |
| Пользователи | itd.users | профили, подписки, блокировки, приватность, значки |
| Посты | itd.posts | лента, публикация, реакции, репосты, опросы, комментарии к постам |
| Комментарии | itd.comments | ответы на комментарии и действия над ними |
| Уведомления | itd.notifications | список, счётчик, отметки о прочтении, настройки |
| Файлы | itd.files | загрузка и удаление медиа |
| Поиск и обнаружение | itd.search, itd.hashtags | глобальный поиск, хэштеги, тренды, рекомендации, кланы, портал |
| Подписка | itd.subscription | состояние премиума, автопродление, способы оплаты |
| Верификация | itd.verification | статус и подача заявки |
| Жалобы | itd.reports | жалобы на контент и пользователей |
| Платформа | itd.platform | версии приложений, журнал изменений, анонсы, портал, статус сервисов |
| Телеметрия | itd.telemetry | явная отправка просмотров и взаимодействий |
| Realtime | itd.realtime() | поток уведомлений, события, транспорт, переподключение |
Несколько аккаунтов
| Категория | Доступ | О чём |
|---|---|---|
| Аккаунты | new ItdAccounts() | контейнер именованных клиентов с общим хранилищем |
Справочники типов
| Файл | О чём |
|---|---|
| Модели данных | Post, Comment, Profile, Notification, Attachment и остальные ответы API |
| Перечисления | FeedTab, SpanType, NotificationType, ReportReason и прочие |
| Ошибки | иерархия ItdError, коды ItdErrorCode, функции-предикаты |
| Билдеры | post(), comment(), poll(), report(), markup(), renderSpans() |
| Пагинация | Page<T>, Paginator<T>, три схемы под одним for await |
| Сессии и хранилища | ItdSession, одно- и мультиаккаунтные storage, itd-api/node |
| Матрица endpoint | wire-контракты, авторизация, статус поддержки и дата проверки |
Общие соглашения
RequestOptions в каждом методе. Почти все методы ресурсов принимают необязательный последний аргумент options: RequestOptions — он не повторяется в сигнатурах ниже:
interface RequestOptions {
signal?: AbortSignal; // отмена запроса
timeout?: number; // таймаут только этого запроса, мс
headers?: Record<string, string>; // дополнительные заголовки
retry?: RetryOptions | false; // повторы только этого запроса
}UserRef против UserId. UserRef — это UUID или имя пользователя: подходят оба (itd.users.get('nowkie') и itd.users.get('9f1c…')). UserId — строго UUID; имя пользователя там не работает (например, wallRecipientId).
Даты. Все поля дат — строки ISO-8601 (IsoDate). Библиотека не превращает их в Date; для разбора есть toDate().
Пагинация. Методы-списки идут парами: list()/comments()/… возвращают одну Page<T>, а iterate()/iterateComments()/… — Paginator<T> для for await. Подробнее — в пагинации.
Снятие обёртки. Сервер оборачивает ответы в { data: … }; библиотека снимает обёртку сама. Чтобы получить тело как есть, используйте itd.request({ …, raw: true }).