API и интеграции
Подключайте приложения с помощью документированного API инференса или API обучения моделей, ограниченных по разрешениям учётных данных, и актуальных справочников по использованию и API.
- Выберите продукт APIРазличайте запросы инференса и процессы обучения моделей.
- Изучите контрактИспользуйте соответствующую документацию API и справочник OpenAPI.
- Создайте ключ с нужными разрешениямиСоздайте клиентский API-ключ и безопасно сохраните его.
- Настройте и проверьте интеграциюОтправьте описанный в документации запрос и изучите ответ.
- Следите за использованием и обновляйте ключиПроверяйте использование и при необходимости отзывайте или заменяйте ключи.
Выберите подходящий сценарий API
API инференса обрабатывает запросы к моделям, а API обучения моделей описывает отдельный процесс обучения, включая предложения, задания, сеансы и артефакты. Не предполагайте, что конечная точка инференса запускает обучение или что операция обучения доступна через контракт инференса. Изучите документацию нужного продукта и убедитесь, что нужная модель или возможность обучения указана. Используйте опубликованные форматы запросов и ответов, а не выводите названия методов из знакомого SDK стороннего поставщика.
- Определите, нужно ли приложению инференс или обучение модели.
- Откройте документацию и справочник API соответствующего продукта.
- Проверьте, что нужная возможность и модель описаны в документации.
Создайте и защитите API-ключ
Создайте клиентский API-ключ на странице управления ключами после входа в систему и, если интерфейс позволяет выбирать области действия, укажите только те, что нужны интеграции. Секрет показывается один раз: сразу сохраните его в утверждённом хранилище секретов. Не помещайте ключ в систему контроля версий, журналы или общедоступный код браузера. По возможности присваивайте ключам метки приложения и среды. Используйте разные ключи для разработки и производства, чтобы можно было отозвать один, не нарушая работу других интеграций.
- Откройте раздел API-ключей в клиентском рабочем пространстве.
- Создайте ключ с минимально необходимой областью действия.
- Безопасно сохраните секрет и не включайте его в код или журналы.
Реализуйте интеграцию по документированному контракту
Следуйте соответствующему руководству по API: учитывайте аутентификацию, конечную точку, поля запросов, обработку ответов и ошибки. Храните учётные данные сервиса на доверенном сервере, а не в общедоступном клиентском коде. Проверяйте входные данные перед отправкой, явно обрабатывайте неуспешные ответы и не записывайте в журналы заголовки авторизации или конфиденциальный текст запросов. Для опубликованного машиночитаемого контракта используйте справочник OpenAPI. Не рассчитывайте на поддержку потоковой передачи, медиафайлов или нативных операций провайдера, если они не указаны в актуальной документации.
- Реализуйте только операции и поля, описанные для выбранного API.
- Храните учётные данные на сервере и удаляйте их из диагностических данных.
- Обрабатывайте документированные ошибки и сохраняйте возвращённые идентификаторы запросов.
Контролируйте использование и управляйте учётными данными
После подключения интеграции проверяйте страницу использования и сопоставляйте отображаемую активность учётной записи с записями приложения. Разберитесь с неожиданными изменениями прежде, чем увеличивать трафик или создавать новые ключи. Если ключ мог попасть к посторонним, замените его, обновите секрет в хранилище приложения и проверьте интеграцию, прежде чем удалять старый ключ. Отзывайте ключи, которые больше не нужны. Сведения об использовании помогают контролировать работу, но не гарантируют будущую стоимость или доступную ёмкость.
- Сопоставьте использование платформы с журналом запросов приложения.
- Замените раскрытый ключ и проверьте новый.
- Отзывайте ненужные ключи и регулярно проверяйте доступ.
Часто задаваемые вопросы
Инференс и обучение моделей используют один и тот же API?
Нет. Это отдельные продукты с разными процессами. Следуйте справочнику для нужной вам возможности.
Где найти описание поддерживаемого API-контракта?
Откройте документацию продукта и справочник OpenAPI по ссылкам в этом руководстве. Там описан актуальный опубликованный интерфейс.
Где хранить секрет API?
Используйте защищённое серверное хранилище секретов. Не добавляйте секрет в репозиторий, код браузера или журналы.
Что делать, если ключ раскрыт?
Замените или отзовите ключ в разделе API-ключей, обновите его в хранилище секретов приложения и проверьте последние данные об использовании на предмет неожиданной активности.