Русский
Выбрать
EnglishФормат запроса к API Топвизор
Основные GET-аргументы запроса
| Аргумент | Описание | Возможные значения |
|---|---|---|
| *api_key | Ключ для доступа к API. | Ключ можно получить на странице настроек вашего аккаунта |
| *oper | Тип запроса |
get - получение объектов / данных add - добавление объекта edit - редактирование объекта / вызов действия |
| *module | Имя модуля с которым ведется работа | bank, mod_projects, mod_keywords и др. |
| func | Имя метода | Возможные имена методов см. в документации к модулю |
| filter |
JSON-строка поиска.
Используется только при oper=get. |
Оъекты со статусом = 3:{"status":"3"}Объекты (с id=1 имеющие статус=0) или (принадлежащие пользователю 5 и имеющие статус=0): {"or":{"id":"1","user_id":"5"},"status":"0"}Оъекты со статусом 1 принадлежащие 1 или 2 пользователю {"user":["1","2"],"status":"1"}Здесь приведены абстрактные примеры, возможные аргументы фильтра указаны в документации к модулю |
| getFormat |
Формат данных. Используется только при oper=get. |
json - исползуется по умолчанию. Результат представляет собой массив из одного или более элементов. json_object - Результат представляет собой объект с одним или более атрибутами. json_pager - Запрос предоставляющий постраничный доступ к данным. Подробнее см. в Постраничный доступ к данным |
* - обязатыльные аргумент