Create connection api
Подключение к внешнему API
Чтобы установить соединение с внешним API, выполните следующие шаги:
1. Нажмите кнопку Создать, расположенную в правом верхнем углу интерфейса.
2. В выпадающем меню выберите раздел Создать соединение с БД, чтобы перейти на страницу со списком подключений.
3. Нажмите на иконку + в правом верхнем углу страницы, чтобы приступить к созданию подключения.
4. Откроется модальное окно для настройки подключения. В поле "Поддерживаемые базы данных" выберите External API.
5. Заполните поле "SQLALCHEMY URI" в следующем формате:
api://?URL=...&key=...
- api
— диалект, используемый для подключения SQLAlchemy к API (это обязательная часть).
- URL
— адрес API, который вы хотите использовать для подключения (это обязательная часть).
- key
— ключ, который будет использоваться для извлечения нужных данных из ответа API (это обязательная часть).
Пример: api://?URL=https://{НУЖНЫЙ ХОСТ}/pmd/public/gw/api/v1/product&key=products
Заголовки запросов (Request Headers)
Если для доступа к API необходимо указать дополнительные заголовки (такие как Authorization
, X-CSRF Token
и т.д.), добавьте их в разделе Параметры коннектора (Продвинутая настройка -> Прочее) в формате:
json
{
"request_headers": {
"Header key1": "Header value1",
"Header key2": "Header value2"
}
}
Требования
- API должен возвращать заголовок с типом контента application/json.
- Значение
key
должно быть списком словарей (или словарем). В противном случае подключение не будет работать.