REST API

Подключение REST API к Apeekflow

Выполните следующие действия, чтобы подключиться к REST API.

1. Нажмите Источники данных на главной странице Apeekflow.

2. Нажмите Создать источник данных в правом верхнем углу. Это разрешение доступно только администраторам workspace и разработчикам.

3. Выберите API > REST API.

4. Настройте общие параметры. Как минимум, введите имя и базовый URL API, к которому нужно подключиться. Заголовки и параметры необязательны. Это все общие параметры, которые состоят из префиксов URL-запросов.

5. Настройте тип аутентификации.

6. Нажмите Сохранить.

Вы также можете подключиться к новому источнику данных REST API при создании или редактировании запросов в библиотеке запросов или редакторе запросов.

Тип аутентификации

Тип аутентификации по умолчанию — Никто. Другими параметрами являются Основной и Дайджест, которые требуют настройки имени пользователя и пароля.

Если вам нужны другие индивидуальные методы аутентификации, обратитесь в нашу службу поддержки клиентов на [e-mail]

Проверка SSL-сертификата

На вкладке Дополнительные настройки вы можете настроить проверку SSL-сертификата для своих источников данных. Доступны три варианта: сертификат центра сертификации, самозаверяющий сертификат или отключенный. По соображениям безопасности Apeekflow по умолчанию принимает API с сертификатами центра сертификации. Для API-интерфейсов без сертификатов CA вы можете либо выбрать Проверить самозаверяющий сертификат и ввести самозаверяющий сертификат, либо отключить проверку SSL-сертификата.

Обратите внимание, что для самозаверяющего сертификата информация должна быть представлена в формате .PEM. Этот сертификат будет зашифрован и надежно сохранен в Apeekflow.

Создайте запрос REST API

Вы можете создавать запросы REST API двумя способами:

• добавьте новый источник данных и затем создайте запрос

• создайте запрос напрямую

Обратите внимание, что без создания нового источника данных источник данных REST API не будет сохранен в ваших источниках данных и, следовательно, к нему нельзя будет получить доступ для создания других запросов.

Создайте запрос с новым источником данных

Выполните следующие действия, чтобы сначала добавить новый источник данных REST API, а затем создать запрос.

1. Подключите REST API для доступа к.

2. В редакторе запросов нажмите + Создать.

3. Выберите добавленный API в источнике данных.

4. Введите URL, заголовки, параметры и, при необходимости, заполните другие поля.

5. Нажмите ▶ Выполнить.

Создайте запрос REST API с предопределенным источником данных

Следуйте инструкциям, чтобы напрямую создать запрос REST API.

1. В редакторе запросов нажмите + Создать.

2. Выберите REST-запрос в разделе Источники данных. Apeekflow предлагает этот встроенный плагин-источник данных, который позволяет быстро создавать запросы REST API без предварительного добавления нового источника данных.

3. Введите URL, запрос, переменные, параметры и, при необходимости, заполните другие поля.

4. Нажмите ▶ Выполнить.