Раздел API на docs.datool.ru: справочник методов с примерами

У API.Max появился полный раздел на docs.datool.ru/api/: 11 статей о том, как подключиться и работать с API, и справочник всех 16 методов. У каждого метода — описание, цена в запросах, ограничения тарифа, параметры, поля ответа, ошибки и готовые примеры на Python и curl с ответом сервера. Подключить данные каналов MAX к своему сервису теперь можно, не задавая ни одного вопроса в поддержку.

API.Max отдаёт те же данные, что вы видите на сайте: каталог и карточки каналов MAX, статистику по дням и посты. Хорошая документация для API — это половина продукта: разработчик должен за несколько минут понять, какой метод вызвать, что передать и что придёт в ответ. Именно так мы и построили раздел.

Как устроен раздел

Раздел состоит из двух частей. Первая — «Начало», статьи о правилах, общих для всех методов:

• Быстрый старт — ключ, первый запрос и статистика канала за пять минут.
• Ключи и авторизация — как передать ключ, кому он принадлежит и когда перестаёт работать.
• Лимиты и расход — сколько стоит запрос, лимит за 30 дней с оплаты, скорость, пакеты.
• Пагинация — страницы списков: курсор, limit и готовая ссылка next.
• Фильтрация и сортировка — все фильтры каталога, постов, статистики и справочников.
• Форматы данных — время, даты, номера, null, деньги и совместимость.
• Ошибки — коды ответа, машинные коды и что делать в каждом случае.
• Вебхуки — новые посты каналов сразу на ваш сервер, с проверкой подписи и примером приёмника.
• MCP для ИИ-ассистентов — данные MAX в Claude, Cursor и других ассистентах тем же ключом.
• Методы MAX — краткая карта всех методов.
• Изменения API — что менялось и когда.

Вторая часть — справочник методов. Методы разбиты на шесть групп: «Аккаунт», «MAX: справочники», «MAX: каналы», «MAX: статистика», «MAX: посты» и «MAX: вебхуки».

Страница метода: всё на одном экране

Каждая группа методов — одна страница, а каждый метод на ней — строка из двух колонок:

• Слева — описание. Плашка HTTP-метода (GET — зелёная, POST — синяя, PATCH — золотая, DELETE — красная), адрес, цена в единицах и ограничения тарифа, если они есть. Например, у статистики по дням указано: «API.Max Тест — только 30 последних дней».
• Таблицы. Параметры (обязательный ли, тип, где передаётся), поля ответа с типами (поля, которые бывают пустыми, подписаны «или null») и ошибки метода с машинным кодом и объяснением, когда они возникают.
• Справа — примеры. Тёмная колонка с запросом на Python и curl и пример ответа. Примеры стоят напротив своего метода, на телефоне — под его описанием. У блоков кода есть кнопка «Скопировать».

В примерах — не условные «1234» и многоточия, а правдоподобные значения: один и тот же вымышленный канал «Городские новости» (@citynews), его посты, статистика и вебхук согласованы между собой во всех методах. Скопированный пример запускается после замены ключа на свой.

Схема OpenAPI и «Попробовать запросы»

На странице справочника есть две кнопки:

• «Скачать схему OpenAPI» — описание всех методов в стандартном формате. Из схемы можно сгенерировать клиент на любом языке или импортировать методы в Postman и Insomnia.
• «Попробовать запросы в Swagger» — страница, где можно вставить свой ключ и выполнить любой метод прямо в браузере, не написав ни строки кода. Оформлена в цветах сайта и ведёт обратно в справочник.

Справочник собирается из того же кода, что обслуживает сами запросы. Поэтому описание метода, его параметры и поля ответа не расходятся с тем, как API работает на деле.

Поиск и журнал изменений

Поиск по документации (клавиша «/») ищет и по методам API — по названию и адресу — и ведёт сразу к нужному методу на странице группы. А статья «Изменения API» — журнал по датам: какие поля и фильтры появились, что исправлено. Новые поля и методы добавляются в версию v1 без смены номера, поэтому правило простое: клиент не должен ломаться от незнакомого поля в ответе.

Если открыть в браузере адрес api.datool.ru, он тоже приведёт в раздел API документации.

Тарифы и как попробовать бесплатно

Цены и лимиты — на странице max.datool.ru/api/. Каждый запрос стоит 1 единицу, сколько бы строк он ни вернул: страница из 100 постов или статистика по 100 каналам — тоже 1. Справочники, /v1/me/ и управление вебхуками бесплатны.

• API.Max Тест — 0 ₽. 1 000 запросов за 30 дней, карточки каналов и статистика за последние 30 дней.
• API.Max Старт — 2 990 ₽ в месяц. 100 000 запросов, карточки, вся статистика и посты.
• API.Max Рост — 9 990 ₽ в месяц. 300 000 запросов и вебхуки о новых постах.
• API.Max Профи — 29 990 ₽ в месяц. 1,5 млн запросов, 20 ключей и право показывать данные своим клиентам.

В подписку «Бизнес» входит 10 000 запросов в месяц. Месяц лимита — 30 дней с момента оплаты.

Как начать

1. Зарегистрируйтесь на hi.datool.ru и откройте «API-ключи».
2. Создайте ключ — на тарифе «Тест» он бесплатный.
3. Откройте «Быстрый старт» и выполните первый запрос /v1/me/ — он ничего не стоит.
4. Найдите нужный метод в справочнике и скопируйте пример.

Частые вопросы