Введение в API Топвизор


Документация содержит описание программного интерфейса (API Топвизор), а также информацию о том, как использовать API, включая описание методов и используемых форматов данных. Руководство предназначено для разработчиков и вебмастеров, которым необходим доступ к данным и возможностям сервиса Топвизор.

Предполагается, что читатель владеет терминологией и понимает принципы работы сервиса. Руководство пользователя, часто задаваемые вопросы и ответы на них находятся в Справчоном центре.

Адрес сервера и авторизация


Все действия в API Топвизор выполняется от имени зарегистрированного в сервисе пользователя. Клиентское приложение должно быть авторизовано посредством API ключа.

Чтобы получить ответ на запрос, необходимо обратиться к серверу API по адресу:

https://api.topvisor.ru/

Постраничный доступ к данным


Для получения большого объема данных рекомендуется использовать постраничный вывод результатов.
Для этого в запросе на получение данных необходимо указать аргумент getFormat=json_pager.

Аргумент Описание Возможные значения
getFormat Формат данных Всегда json_pager
rows Количество возвращаемых объектов От 1 до ∞.
Разные методы могут иметь различные ограничения по максимальному значению.
page Номер страницы От 1 до ∞

Ответ сервера для постраничного запроса

{ page: 1, // номер страницы total: 9, // всего страниц records: 90, // всего найденных результатов rows: [...] // массив результатов }