Создание подключения по REST API

REST API — это способ взаимодействия между программами через HTTP-запросы, позволяющий получать и отправлять данные между клиентом и сервером. В отличие от «обычного» API, REST строится на стандартных HTTP-методах (у нас это GET и POST) и работает с ресурсами по URL, что делает его более универсальным и простым в интеграции.

В этой инструкции мы разберём, как настроить подключение к REST API в диспетчере данных — от заполнения базовых полей (название, URL, метод запроса) до настройки параметров авторизации, заголовков, тела запроса и других опций.

Где найти

Перейдите в Диспетчер данных (Скрипт загрузки) → Создать подключение → REST API. Откроется модальное окно «Создание подключения».

Создание подключения

1. Название источника:

   • введите имя для вашего подключения (обязательно для заполнения);
   • используйте только латинские буквы, цифры и спецсимволы: * / . - = _ < > ^ % & ! ? @ ' " : ; #.
   • если используете другие символы — появится ошибка: «Поле содержит некорректные символы».

2. URL (обязательно для заполнения):

   • укажите URL-адрес API, к которому хотите подключиться;
   • проверьте корректность URL перед продолжением.

3. Выберите метод запроса:

   • GET — используется для получения информации от сервера (например, просмотр веб-страницы или получение данных из API);
   • POST — используется для создания нового ресурса на сервере (передаёт данные для создания ресурса)

Параметры подключения

У вас есть 4 вкладки для настройки: Params, Authorization, Headers, Body:

Вкладка «Params»

• добавьте параметры запроса в виде пар «Ключ — Значение»;

• используйте кнопку:

  • «Добавить» — для добавления новой строки с параметрами

• выберите формат источника из выпадающего списка. Доступно три: CSV, JSON, HML. Если выбран вариант CSV, то появляются чекбокс "Включать заголовки" и поле ввода "Разделитель"

Вкладка «Authorization»

Выберите тип авторизации из списка:

1. No auth (по умолчанию) — без авторизации (нет дополнительных параметров).

2. Basic auth — появятся поля:

   • «Имя пользователя»;
   • «Пароль».

3. Bearer token — появится поле:

   • «Токен».

4. API Key — появятся поля:

   • «Ключ»;
   • «Значение».

Вкладка «Headers»

• добавьте заголовки запроса в виде пар «Ключ — Значение»;
• Кнопка «Добавить» — для добавления дополнительного ключа

Вкладка «Body»

• выберите формат ввода:

  • поля ввода ключей/значений (form-data) — для структурированных данных;
  • многострочный инпут (raw) — для свободного ввода текста.

Настройка дополнительных параметров

1. Формат источника (раскрывающийся список):

   • выберите один из трёх форматов: XML, CSV, JSON.

   • если выбран CSV, появятся дополнительные настройки:

     • чекбокс «Включать заголовки»;
     • поле ввода «Разделитель»

2. Таймаут (в секундах):

   • по умолчанию — 120 секунд; при необходимости измените значение.

3. Автообновление. Поставьте галочку в чекбоксе «Автообновление», если хотите, чтобы подключение обновлялось автоматически.

4. Проверьте подключение. Нажмите кнопку «Тест соединения», чтобы проверить корректность настроек и доступность API.

Сохраните подключение

к сведению

Если вы хотите отменить настройку и вернуться к выбору типа подключения — нажмите кнопку «Назад». Введённые параметры не сохранятся.

Нажмите кнопку «Создать»:

• система проверит заполненность полей «Название подключения» и «URL»;
• если поля пустые, появится ошибка: «Поле не может быть пустым!»;
• если все поля заполнены корректно, подключение будет создано.