Перейти к документации
ДокументацияКлючи и агенты

Ключи сервисов, подключения и разрешения

Ключ сервиса хранит способ входа к поставщику, подключение открывает хост агенту, а разрешение даёт временный одобренный доступ.

На этой странице

Различайте три объекта

Раздел консолиЗначение
Ключ сервиса / Ключи сервисовКлюч API поставщика или OAuth-подключение, которое Sallyport хранит для вызовов сервиса. Секрет никогда не передаётся агенту.
Подключение / ПодключенияСвязь ключа сервиса с хостом и правила, по которым выполняются вызовы.
Разрешение / РазрешенияВременный доступ после подтверждения с собственной областью, лимитом использования и сроком действия.

Подключите собственный HTTP API

Откройте добавление ключа и выберите «Свой API». Укажите HTTPS-адрес сервиса, способ авторизации и ключ. Sallyport создаст ключ сервиса и HTTP-подключение без рецепта из каталога.

АвторизацияЧто подставит Sallyport
BearerAuthorization: Bearer …
X-API-KeyX-API-Key: …
Authorization tokenAuthorization: token …
BasicИмя пользователя и пароль в заголовке HTTP Basic.
Свой заголовок / несколько заголовковИменованные заголовки с отдельными сохранёнными значениями и необязательными префиксами.
Параметр запросаСохранённый ключ в параметре, который ожидает сервис, например api_key.
JSON-тело / путь URLДля HTTP API, которые ожидают ключ в поле JSON или сегменте пути. Укажите JSON-указатель или сегмент с {{credential}}.

Используйте доступный из интернета HTTPS-адрес, при необходимости с портом, например https://api.example.com:8443/v1. Не включайте в адрес логин, пароль, параметры запроса или фрагмент. Обычные параметры запроса и заголовки по умолчанию задаются отдельно; ключи — в полях авторизации. Путь, например /v1, ограничивает подключение этим путём. Агент вызывает полный адрес сервиса через http.request, включая порт и путь. Для агентов с вариантом «Только выбранные подключения» выберите новое подключение в настройках агента.

Подключите сохранённый ключ из каталога

После сохранения ключа из каталога выберите «Подключить сервис» на его странице. Укажите хост сервиса и рабочее пространство, затем сохраните подключение. Можно начать и с раздела Подключения, выбрав существующий ключ. Агент также может вызвать sallyport.request_access: выдача доступа в разделе Запросы доступа создаёт ключ и подключение вместе.

Осознанно выберите доступ и правила

«Всё рабочее пространство» даёт агенту доступ к подключениям рабочего пространства; «Только выбранные подключения» работает как список разрешённых подключений. Выдача доступа по запросу добавляет запросившего агента с таким объёмом доступа к новому подключению. Настройте обработку вызовов в разделе Правила, а временный доступ после подтверждения смотрите в разделе Разрешения.

Безопасно замените ключ поставщика

Сначала выпустите у поставщика отдельный новый ключ. В Sallyport откройте ключ сервиса, нажмите «Заменить ключ сервиса», сохраните новое значение и проверьте его безопасным вызовом. Только после успешной проверки отзовите старый ключ у поставщика. Не отзывайте ключ, который Sallyport ещё использует.