Войти

Справочники

Методы группы «MAX: справочники». Справа — пример запроса и ответа для каждого.

Справочник рубрик

GET/v1/max/categories/
0 единицвсе тарифы, включая «API.Max Тест»

Все рубрики каналов MAX в порядке справочника, как на сайте: номер, код, название, число каналов и картинка. Код рубрики подставляют в фильтр каталога ?category=. Метод бесплатный (0 единиц).

Поля ответа

ПолеТипОписание
resultsсписокВсе рубрики в порядке справочника
results[].idчислоНомер рубрики в справочнике datool.ru
results[].slugстрокаКод рубрики — им фильтруют каталог (?category=)
results[].nameстрокаНазвание рубрики (по-русски, как на сайте)
results[].channelsчислоКаналов в рубрике (ночной пересчёт)
results[].imageстрока или nullКартинка рубрики до 500 пикселей (WebP) или null

Ошибки

КодcodeКогда
401not_authenticated / authentication_failedНет ключа, ключ неверный или отозван, участник приостановлен или организация ключа в архиве.
429rate_limited / throttledСлишком часто — больше запросов в секунду, чем по тарифу; сколько ждать — в заголовке Retry-After.
503timeoutЗапрос к базе не уложился в 5 секунд — повторите позже или сузьте выборку.

Справочник территорий

GET/v1/max/territories/
0 единицвсе тарифы, включая «API.Max Тест»

Дерево территорий: страна → федеральный округ → регион → город (города — только у России). Без фильтров — всё дерево, родитель перед потомками; parent — прямые потомки одного узла, kind — узлы одного уровня. Код территории подставляют в фильтр каталога ?territory= — он находит канал и в дочерних узлах. Метод бесплатный (0 единиц).

Параметры

Имя параметраГдеОписание
kind
строка
запросТолько узлы этого уровня
Значения: city, country, district, region
parent
строка
запросКод узла — вернуть только его прямых потомков

Поля ответа

ПолеТипОписание
resultsсписокУзлы дерева: родитель перед потомками
results[].idчислоНомер узла в справочнике территорий
results[].slugстрокаКод территории — им фильтруют каталог (?territory=)
results[].nameстрокаНазвание территории (по-русски)
results[].kindстрокаУровень: country — страна, district — федеральный округ, region — регион, city — город
results[].parentстрока или nullКод родительского узла или null у страны
results[].pathстрокаКоды узлов от страны до этого узла через «/»
results[].channelsчислоКаналов в узле и его потомках (ночной пересчёт)

Ошибки

КодcodeКогда
400ошибки полейНеверный параметр или поле тела: ошибка приходит у имени поля, например {"channels": ["Номера каналов через запятую."]}.
401not_authenticated / authentication_failedНет ключа, ключ неверный или отозван, участник приостановлен или организация ключа в архиве.
429rate_limited / throttledСлишком часто — больше запросов в секунду, чем по тарифу; сколько ждать — в заголовке Retry-After.
503timeoutЗапрос к базе не уложился в 5 секунд — повторите позже или сузьте выборку.

Формат ошибок, заголовки лимитов и что делать при каждой — в статье «Ошибки».

Страница полезна?

Вы покидаете datool.ru

Ссылка ведёт на внешний сайт. datool.ru не отвечает за его содержимое — проверьте адрес, прежде чем вводить пароли или платёжные данные.

Переход через 10 с

Перейти