Что такое API-ключ

API-ключ — это учётные данные, предоставляемые SoleAPI для вызова открытого API. Ключ можно создать после регистрации аккаунта. API-ключи SoleAPI начинаются с sk-sole-.

Создавать и удалять ключи можно в разделе Управление API-ключами.

Параметры и правила при создании API-ключа

Название

Задайте понятное название API-ключа, чтобы упростить его дальнейшее управление.

Группы планирования

Группы планирования определяют, какие модели доступны текущему API-ключу. Если группы не выбраны, по умолчанию ключ может вызывать модели всех вышестоящих поставщиков, доступных на платформе. После выбора доступность ограничивается выбранными группами.

• Даже если сервис модели указан для совместимой точки входа протокола, он может быть недоступен из-за групп планирования API-ключа, снятия модели с публикации или прав аккаунта.
  Если ничего не выбрано, API-ключ по умолчанию может вызывать модели всех вышестоящих поставщиков платформы. См. Каталог моделей.

Предпочтение маршрутизации

SoleAPI предлагает несколько вариантов маршрутизации:

• Умная маршрутизация (по умолчанию): администраторы отмечают качественные источники для каждого поставщика, и этот вариант отдаёт им приоритет.
• Минимальная стоимость: цены разных вышестоящих источников могут отличаться даже для одной модели. Этот вариант выбирает более дешёвые источники.
• Минимальная задержка: приоритет получают источники с меньшей измеренной задержкой.
• Максимальная стабильность: приоритет получают источники с наибольшей долей успешных запросов за последнее время.

Лимит расходов

Платформа учитывает расходы каждого API-ключа в Credits. Для каждого ключа можно задать отдельный лимит. После его достижения запросы отклоняются с HTTP 402.
Значение 0 означает отсутствие лимита.

Срок действия

Для API-ключа можно задать срок действия. После его истечения ключ автоматически отключается, что удобно для временных интеграций или передачи третьим лицам.
Оставьте поле пустым, чтобы ключ действовал бессрочно.

Список разрешённых IP-адресов

Для API-ключа можно настроить список разрешённых IP-адресов. Использовать ключ смогут только запросы с указанных адресов; остальные будут отклоняться с HTTP 403. Если у устройства постоянный IP-адрес, эта мера снижает риск несанкционированного использования ключа после утечки.
Оставьте поле пустым, чтобы разрешить доступ со всех IP-адресов.

Включение и отключение

Ключ можно отключить в любой момент без удаления истории использования.