Формирование пробного запроса
Заполнение таблицы с параметрами
По обязательности параметры метода делятся на:
обязательные - без их указания метод будет возвращать ошибку;
необязательные - включаются в запрос только при необходимости.
Заполните значения для всех обязательных и необходимых Вам необязательных параметров.
Для некоторых параметров указаны значения по умолчанию, которые используются методом, если не указано другое значение.
Параметры могут быть простых типов (int, date, double, string…) или объектами.
Параметры-объекты, как правило, передаются в виде списка элементов класса.
-- вместо значения типа для параметра-объекта в таблице используется такой значок. При нажатии на значок разворачивается таблица с полями элементов класса:
Обратите внимание! В таблице с полями элементов класса указаны не значения по умолчанию, а примеры значений.
Заполните таблицу для одного элемента класса и нажмите “Добавить”. Отредактируйте таблицу для второго элемента класса и снова нажмите “Добавить” и т.д. для всех элементов параметра-объекта.
Добавляемые элементы класса отображаются в поле “Значение” основной таблицы.
Вы можете скопировать сформированные данные в текстовый редактор и ознакомиться со структурой запроса для этой переменной-объекта:
-- Для скрытия таблицы повторно нажмите на значок.
При заполнении таблицы в окне “Пробовать” автоматически формируется код запроса:
Вы также можете скопировать код в текстовый редактор и ознакомиться со структурой запроса вцелом.
При нажатии на кнопку “Отправить” запрос отправляется на сервер. После его обработки в окне “Ответ” отобразится результат выполнения метода:
Для методов GET, как правило, приходят громоздкие ответы. Их можно открыть в отдельном окне (ссылка вверху справа):
Формат пробного запроса
По умолчанию пробный запрос формируется в JSON-формате.
Выбрать другой формат запроса можно в выпадающем списке над окном “Пробовать”.
Обратите внимание! Если Вам необходимо сформировать запрос в xml-формате, установите его ДО заполнения таблицы с параметрами. Если необходимо поменять формат запроса, а окно с кодом уже заполнено данными в другом формате, очистите все поля таблицы с параметрами и окно с кодом, перезагрузите страницу. Теперь можете выбрать другой формат и приступить к заполнению таблицы.
При формировании пробного запроса в формате XML на странице API к коду не добавляется параметр “format=xml”. Если Вы формируете запрос из своей учетной системы в xml формате, обязательно добавляйте данный параметр ко всем запросам.
Например:
Автоматически сформированный запрос в XML-формате на странице API:
Запрос, отправляемый из Вашей учетной системы:
