Platitun · API · Справочник и заявки · Поиск позиции справочника

Поиск позиции справочника

GET /api/v1/catalog/services

Область ключа: catalog · только чтение

Справочник сервисов площадки. Он только читается: правит его администратор, и это не оговорка — два «Cursor Pro» с разными названиями покупатель не отличит. Выключенные сервисы наружу не отдаются вовсе.

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

Отбор в адресе

ПолеТипЧто это
qstringПоиск по имени сервиса, вендору или короткому имени.
categorystringТолько из этого раздела справочника.
limitintegerСколько записей вернуть. Умолчание 50, предел 200.
cursorstringЗначение nextCursor из прошлого ответа. Номеров страниц нет: пока листаешь, список меняется.

Поля ответа

ПолеТипЧто это
itemsarrayЗаписи страницы.
items[].servicestringКороткое имя сервиса — им сервис называется во всех остальных путях.
items[].namestringНазвание, как его пишет вендор.
items[].vendorstringКто делает сервис.
items[].categoriesarrayРазделы справочника: сервис бывает сразу в нескольких.
items[].productTypesarrayКакие виды товара по этой позиции возможны.
items[].tariffCountintegerСколько у сервиса планов вендора.
nextCursorstring|nullКурсор следующей страницы. Пусто — страница последняя.

Пример

GET /api/v1/catalog/services?q=cursor&limit=2

→ 200 { "items": [ { "service": "cursor", "name": "Cursor", "vendor": "Anysphere",
        "productTypes": ["subscription","account_with_subscription","account"],
        "tariffCount": 3 } ], "nextCursor": null }

Рядом в этом разделе