Административный API
Административный API позволяет программно управлять ресурсами вашей организации, включая участников организации, рабочие пространства и API-ключи. Это обеспечивает программный контроль над административными задачами, которые в противном случае требовали бы ручной настройки в Anthropic Console.
Административный API требует специального доступа
Административный API требует специального административного API-ключа (начинающегося с sk-ant-admin...), который отличается от стандартных API-ключей. Только участники организации с ролью администратора могут предоставлять административные API-ключи через Anthropic Console.
Как работает административный API
Когда вы используете административный API:
- Вы делаете запросы, используя ваш административный API-ключ в заголовке
x-api-key - API позволяет вам управлять:
- Участниками организации и их ролями
- Приглашениями участников организации
- Рабочими пространствами и их участниками
- API-ключами
Это полезно для:
- Автоматизации подключения/отключения пользователей
- Программного управления доступом к рабочим пространствам
- Мониторинга и управления использованием API-ключей
Роли и разрешения в организации
Существует четыре роли на уровне организации.
| Роль | Разрешения |
|---|---|
| user | Может использовать Workbench |
| developer | Может использовать Workbench и управлять API-ключами |
| billing | Может использовать Workbench и управлять платежными данными |
| admin | Может делать все вышеперечисленное, плюс управлять пользователями |
Ключевые концепции
Участники организации
Вы можете просматривать список участников организации, обновлять роли участников и удалять участников.
Приглашения в организацию
Вы можете приглашать пользователей в организации и управлять этими приглашениями.
Рабочие пространства
Создавайте и управляйте рабочими пространствами для организации ваших ресурсов:
Участники рабочего пространства
Управляйте доступом пользователей к конкретным рабочим пространствам:
API-ключи
Отслеживайте и управляйте API-ключами:
Лучшие практики
Для эффективного использования административного API:
- Используйте осмысленные имена и описания для рабочих пространств и API-ключей
- Реализуйте правильную обработку ошибок для неудачных операций
- Регулярно проверяйте роли и разрешения участников
- Очищайте неиспользуемые рабочие пространства и истекшие приглашения
- Отслеживайте использование API-ключей и периодически меняйте их