Руководства
Сценарная документация itd-api: от первого публичного запроса до сессий, событий, нескольких аккаунтов и собственных расширений. Если нужна точная сигнатура метода или поля ответа, переходите в справочник API.
С чего начать
- Быстрый старт — установить пакет, создать клиент, прочитать данные и опубликовать пост.
- Авторизация и сессии — выбрать способ входа и безопасно сохранить обновляемую сессию.
- Конфигурация клиента — настроить таймауты, повторы, очередь запросов, сервисы и жизненный цикл.
По задаче
| Задача | Руководство |
|---|---|
| Войти, обновлять токен, пережить перезапуск | Авторизация и сессии |
| Работать с несколькими профилями | Несколько аккаунтов |
| Получать уведомления в реальном времени | События |
| Создать форматированный пост | Разметка текста |
| Использовать браузерный прокси, HTTP/SOCKS5 или капчу | Интеграции |
| Подключить кэширование, шифрование или написать плагин | Плагины |
| Добавить предметный API поверх общей сессии | Подключаемые модули |
| Разобраться в порядке обработки запроса | Порядок выполнения запроса |
| Настроить повторы, ограничения частоты, хуки или дополнительные серверы | Конфигурация клиента |
| Найти метод, тип, ошибку или enum | Справочник API |
Справочник
В reference/ методы сгруппированы по ресурсам клиента: itd.users, itd.posts, itd.notifications и остальным. Там же находятся модели данных, ошибки, пагинация, билдеры и хранилища.
Почти каждый метод последним аргументом принимает RequestOptions: можно задать AbortSignal, локальный таймаут, дополнительные заголовки, политику повторов и настройки плагинов. Параметры метода API передаются отдельным объектом, а у методов-итераторов maxPages входит в PaginationOptions.
Запуск примеров
Установите зависимости и соберите библиотеку:
npm install
npm run buildКоманды запуска и нужные переменные окружения указаны рядом с каждым примером. Примеры, которые меняют данные, требуют явных учётных данных; тесты проекта к рабочему API не обращаются.