Ключ API и аутентификация
Создавайте ключи API AGTCloud, управляйте ими и настраивайте Header аутентификации для интерфейсов.
Ключ API подтверждает вашу личность при запросах к AGTCloud API. Большинство интерфейсов используют ключ API в формате Bearer; совместимые протоколы, такие как Anthropic Messages, используют специальные Header аутентификации. Точные требования указаны на странице соответствующего Endpoint.
| Настройка | Значение |
|---|---|
| Base URL | https://api.agtcloud.cn/v1 |
| Большинство интерфейсов | Authorization: Bearer your-api-key |
| Anthropic Messages | x-api-key: your-api-key и anthropic-version: 2023-06-01 |
Создание ключа API
- Откройте API Keys.
- Нажмите Создать ключ API.
- Скопируйте ключ API и сохраните его в безопасном месте.
Безопасное хранение ключа API
Не показывайте полный ключ API на снимках экрана, в переписке, обращениях в поддержку или открытом коде. При подозрении на утечку отключите или удалите старый ключ и создайте новый токен.
Использование ключа API
Аутентификация Bearer
Используйте https://api.agtcloud.cn/v1 как Base URL и добавьте в запрос:
Authorization: Bearer your-api-keyРекомендуемый Base URL уже содержит /v1. При составлении адреса запроса не добавляйте /v1 повторно, иначе путь будет неверным.
Проверка ключа API
Запросите список моделей, доступных текущему ключу API, чтобы проверить Base URL и настройки аутентификации:
curl 'https://api.agtcloud.cn/v1/models' \
-H 'Authorization: Bearer your-api-key'Anthropic Messages
При вызове совместимого интерфейса Anthropic Messages передавайте ключ API через x-api-key и укажите обязательный anthropic-version:
x-api-key: your-api-key
anthropic-version: 2023-06-01Полные требования к запросу смотрите в Anthropic Messages.
Управление ключами API
На странице API Keys можно:
- Добавлять токены для разных сред или приложений.
- Отключать неиспользуемые токены или токены с подозрением на утечку.
- Удалять токены, которые больше не нужны.
Настройка сторонних инструментов
Для сторонних инструментов с протоколом, совместимым с OpenAI, обычно необходимо указать:
| Настройка | Что указать |
|---|---|
| API Host / Base URL | https://api.agtcloud.cn/v1 |
| API Key | Ключ API текущего аккаунта |
| Модель | ID модели, доступной на текущем сайте и текущему аккаунту |
ID модели можно найти в каталоге моделей. Инструкции по настройке смотрите в разделе Сторонние интеграции.
Безопасность
В рабочем сервисе получайте ключ API из серверных переменных окружения или сервиса управления секретами:
export AGTCLOUD_API_KEY='your-api-key'- Не записывайте ключ API в исходный код и не добавляйте его в систему контроля версий.
- Не передавайте ключ API в клиентскую часть браузера, пакет мобильного приложения или другие недоверенные клиенты.
- Используйте разные ключи API для разработки, тестирования и рабочей среды.
- При подозрении на утечку немедленно отключите или удалите старый ключ API и замените его новым.