Справочники
Методы группы «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 | Когда |
|---|---|---|
| 401 | not_authenticated / authentication_failed | Нет ключа, ключ неверный или отозван, участник приостановлен или организация ключа в архиве. |
| 429 | rate_limited / throttled | Слишком часто — больше запросов в секунду, чем по тарифу; сколько ждать — в заголовке Retry-After. |
| 503 | timeout | Запрос к базе не уложился в 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": ["Номера каналов через запятую."]}. |
| 401 | not_authenticated / authentication_failed | Нет ключа, ключ неверный или отозван, участник приостановлен или организация ключа в архиве. |
| 429 | rate_limited / throttled | Слишком часто — больше запросов в секунду, чем по тарифу; сколько ждать — в заголовке Retry-After. |
| 503 | timeout | Запрос к базе не уложился в 5 секунд — повторите позже или сузьте выборку. |
Формат ошибок, заголовки лимитов и что делать при каждой — в статье «Ошибки».