Создавайте API-ключи для программного доступа к Entity Enricher. Используйте ключи доступа организации для интеграции между сервисами, конвейеров CI/CD и автоматизированных рабочих процессов.
Entity Enricher поддерживает два типа ключей API, каждый из которых подходит для разных сценариев использования:
Автономные ключи с собственной ролью, не привязанные к учётной записи пользователя. Оптимальный выбор для интеграции между сервисами.
Ключи, привязанные к конкретной учётной записи пользователя. Они наследуют роль создателя и зависят от изменений учётной записи.
ent_a1b2c3d4e5f6g7h8Ключи используют префикс ent_, за которым следуют случайные байты. Полный ключ показывается только один раз при создании — позже его нельзя получить.
Ключи доступа (для вызова API Entity Enricher) хранятся в базе данных в виде хешей SHA256, поэтому даже при наличии доступа к базе данных исходный ключ восстановить невозможно. В открытом виде для идентификации хранятся только первые 12 символов (префикс).
Ключи провайдеров (ключи LLM API, такие как Anthropic, OpenAI) шифруются при хранении с помощью симметричного шифрования Fernet (AES-128-CBC + HMAC). Они должны поддаваться расшифровке во время выполнения для аутентификации у провайдеров LLM. В открытом виде хранятся только последние 4 символа.
Создавайте ключи на странице «API-ключи» в приложении или программно через REST API:
| Поле | Описание |
|---|---|
| Название | Описательное имя для идентификации (например, «CI/CD Pipeline», «Интеграция с n8n») |
| Роль | Уровень доступа: owner, editor или operator. Определяет, к чему имеет доступ ключ. |
| Области действия | read, write или both. Определяет, может ли ключ изменять данные или только читать их. |
| Срок действия | Необязательная дата истечения срока. Ключи без срока действуют до отзыва. |
Отправляйте свой API-ключ в заголовке X-API-Key с каждым запросом:
curl -H "X-API-Key: ent_your_key_here" \
https://your-instance.example.com/api/enrichment/options| Метод | Заголовок | Сценарий использования |
|---|---|---|
| Ключ API | X-API-Key: ent_... | Межсервисное взаимодействие, CI/CD, автоматизация |
| Токен Bearer | Authorization: Bearer <jwt> | Веб-клиенты, интерактивные сессии |
Роль ключа API определяет, к каким конечным точкам он имеет доступ:
| Категория эндпоинта | Минимальная роль |
|---|---|
| Обогащение (одиночное, пакетное) | Оператор |
| Записи (список, сведения, удаление) | Оператор |
| Схема (чтение) | Оператор |
| Схема (создание, редактирование, удаление) | Редактор |
| Слияние | Оператор |
| Сведения о провайдере | Оператор |
| Аналитика стоимости | Оператор |
| Управление ключами API | Владелец |
| Управление пользователями | Владелец |
Страница ключей API предоставляет полный обзор всех ключей организации со статистикой использования:
Страница ключей API содержит несколько вкладок для разных целей:
Ключи API провайдеров LLM вашей организации (Anthropic, OpenAI и др.) для независимого биллинга. Поддерживается несколько ключей на провайдера с автоматической LRU-ротацией. См. Модели и цены для системы BYOK.
Ключи провайдера шифруются при хранении с помощью симметричного шифрования Fernet (AES-128-CBC с аутентификацией HMAC). Они расшифровываются только во время выполнения при вызовах API LLM. В открытом виде для отображения хранятся только последние 4 символа.
Общесистемные ключи провайдеров LLM, управляемые администраторами. Используются как запасной вариант, когда ключ организации недоступен. Поддерживается несколько ключей на провайдера с ротацией LRU и автоматическим отключением при постоянных сбоях.
Ключи для доступа к собственному API Entity Enricher. Используются внешними системами для программного вызова эндпоинтов обогащения, схем, записей и других. Смотрите справочник по API для документации по эндпоинтам.