Документация и API datool.ru — на английском языке

Документация datool.ru и справочник API теперь полностью доступны на английском языке. На docs.datool.ru/en/ переведены все 52 статьи раздела «Документация» и 11 статей раздела «API», а также справочник всех 16 методов: описания, параметры, поля ответа, ошибки и комментарии в примерах кода. Скриншоты в английских статьях сняты с английской версии сайта.

Зачем это нужно. MAX читают и за пределами России, а с данными о каналах работают не только русскоязычные команды: зарубежные агентства, разработчики сервисов, исследователи. Им важно понимать методику без машинного перевода страницы, а разработчику — подключить API по документации на привычном языке. Английская версия — не подстрочник: термины интерфейса едины во всех статьях, названия разделов совпадают с английскими подписями на самом сайте.

Что переведено

• Раздел «Документация» — все статьи о витрине MAX, странице канала и её вкладках, разделе «Моё в MAX», кабинете и методиках расчёта показателей: docs.datool.ru/en/.
• Раздел «API» — быстрый старт, ключи и авторизация, лимиты и расход, пагинация, фильтры, форматы данных, ошибки, вебхуки, MCP для ИИ-ассистентов и журнал изменений API: docs.datool.ru/en/api/.
• Справочник методов — у каждого метода английское описание, таблицы параметров и полей ответа, таблица ошибок и примеры запросов на Python и curl с комментариями на английском: docs.datool.ru/en/api/methods/.
• Страница тарифов API — max.datool.ru/en/api/: тарифы API.Max Test, Start, Growth, Profi и Corporate, правила расчёта запросов.
• Файлы для ИИ-ассистентов — английские llms.txt и llms-full.txt: оглавление и полный текст документации на английском.

Английский — и в самом API

Перевод касается не только страниц документации. Сам API тоже отвечает по-английски, если попросить:

• Тексты ошибок. Передайте заголовок Accept-Language: en — и detail в ответе об ошибке придёт на английском. Машинный код ошибки (code) от языка не зависит, поэтому программа разбирает ответ одинаково.
• Схема OpenAPI. Описание всех методов в формате OpenAPI по адресу https://api.datool.ru/v1/schema/ отдаётся на английском по тому же заголовку или с параметром ?lang=en. Из неё можно сгенерировать клиент или импортировать методы в Postman — с английскими описаниями.
• Названия рубрик и территорий. В справочниках рубрик и территорий и в карточке канала, помимо русского названия, есть поле name_en: «Новости и СМИ» — «News and media», регионы — по-английски. Это удобно для англоязычных отчётов и интерфейсов.

Сами данные остаются такими, как в MAX: названия каналов и тексты постов не переводятся.

Отдельные адреса для каждого языка

Русские статьи живут по адресам docs.datool.ru/…, английские — docs.datool.ru/en/…. У каждой пары страниц взаимные ссылки hreflang, поэтому поисковики показывают англоязычному читателю английскую статью, а не русскую.

Флаг в верхней полосе документации переключает язык и оставляет вас на той же странице: из английской статьи о дашборде вы попадёте в русскую статью о дашборде, а не на главную. На английской версии сайта ссылка «Справка» в подвале кабинета тоже ведёт на английскую статью.

Как мы следим, чтобы перевод не устаревал

Документация обновляется вместе с сайтом, и обе версии правятся вместе. Если русскую статью поправили, а английскую ещё нет, на английской странице появляется пометка о том, что перевод может отставать, — читатель сразу видит, что стоит свериться с русским текстом. Описания методов API хранятся в коде вместе с переводом, поэтому английский справочник меняется одновременно с русским.

Кому это полезно

• Зарубежным агентствам и рекламодателям, которые выбирают каналы MAX для размещения и хотят понимать, как считаются охваты, вовлечённость и индекс качества.
• Разработчикам, которые подключают API.Max: можно читать документацию, получать ошибки и схему на английском и показывать англоязычные названия рубрик в своём интерфейсе.
• Командам с сотрудниками, которые не читают по-русски: один и тот же справочник на двух языках, ссылки на соответствующие статьи совпадают.
• Исследователям рынка мессенджеров, которым нужна понятная методика данных.

Как переключиться на английский

1. Откройте docs.datool.ru.
2. Нажмите на флаг в верхней полосе и выберите English — или сразу откройте docs.datool.ru/en/.
3. Для API добавьте к запросам заголовок Accept-Language: en, а схему берите с ?lang=en.

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