Формування пробного запиту
Заповнення таблиці з параметрами
За обов'язковістю параметри методу поділяються на:
обов'язкові – без їхньої вказівки метод повертатиме помилку;
необов'язкові – включаються до запиту тільки за необхідності.
Заповніть значення для всіх обов'язкових і необхідних Вам необов'язкових параметрів.
Для деяких параметрів вказані значення за замовчуванням, які використовуються методом, якщо не вказано інше значення.
Параметри можуть бути простих типів (int, date, double, string...) або об'єктами.
Параметри-об'єкти, як правило, передаються у вигляді списку елементів класу.
– замість значення типу для параметра-об'єкта в таблиці використовується такий значок. При натисканні на значок розгортається таблиця з полями елементів класу:
Зверніть увагу! У таблиці з полями елементів класу вказані не значення за замовчуванням, а приклади значень.
Заповніть таблицю для одного елемента класу і натисніть "Додати". Відредагуйте таблицю для другого елемента класу і знову натисніть "Додати" тощо для всіх елементів параметра-об'єкта.
Елементи класу, що додаються, відображаються в полі "Значення" основної таблиці.
Ви можете скопіювати сформовані дані в текстовий редактор і ознайомитися зі структурою запиту для цієї змінної-об'єкта:
-- Для приховування таблиці повторно натисніть на значок.
Під час заповнення таблиці у вікні «Пробувати» автоматично формується код запиту:
Ви також можете скопіювати код у текстовий редактор і ознайомитися зі структурою запиту в цілому.
При натисканні на кнопку "Відправити" запит відправляється на сервер. Після його обробки у вікні "Відповідь" відобразиться результат виконання методу:
Для методів GET, як правило, приходять громіздкі відповіді. Їх можна відкрити в окремому вікні (посилання вгорі праворуч):
Формат пробного запиту
За замовчуванням пробний запит формується в JSON-форматі.
Вибрати інший формат запиту можна у випадаючому списку над вікном "Пробувати".
Зверніть увагу! Якщо Вам необхідно сформувати запит у xml-форматі, встановіть його ДО заповнення таблиці з параметрами. Якщо необхідно змінити формат запиту, а вікно з кодом уже заповнене даними в іншому форматі, очистіть усі поля таблиці з параметрами та вікно з кодом, перезавантажте сторінку. Тепер можете вибрати інший формат і починати заповнення таблиці.
Під час формування пробного запиту у форматі XML на сторінці API до коду не додається параметр «format=xml». Якщо Ви формуєте запит зі своєї облікової системи в xml форматі, обов'язково додавайте цей параметр до всіх запитів.
Наприклад:
Автоматично сформований запит в XML-форматі на сторінці API:
Запит, що надсилається з Вашої облікової системи:
