Ключи API

Создавайте 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 символа.

  1. 1Готовый вызов curl с ключом, уже подставленным в заголовок
Тело ключа на этом скриншоте скрыто намеренно. База данных хранит только префикс ent_ и хеш, поэтому ключ, который не был скопирован здесь, можно только заменить, но не восстановить.

Создание ключей API

Создавайте ключи на странице «API-ключи» в приложении или программно через REST API:

Настройка ключа

ПолеОписание
НазваниеОписательное имя для идентификации (например, «CI/CD Pipeline», «Интеграция с n8n»)
РольУровень доступа: owner, editor или operator. Определяет, к чему имеет доступ ключ.
Области действияread, write или both. Определяет, может ли ключ изменять данные или только читать их.
Срок действияНеобязательная дата истечения срока. Ключи без срока действуют до отзыва.
  1. 1Собственная роль ключа — и она никогда не может быть выше вашей
  2. 2Без срока действия — ключ действует, пока его кто-нибудь не отзовёт
Области действия — единственное поле, которого нет в форме: созданный здесь ключ даёт и чтение, и запись, а ключ только для чтения запрашивается через API.

Использование API-ключей

Отправляйте свой API-ключ в заголовке X-API-Key с каждым запросом:

curl -H "X-API-Key: ent_your_key_here" \
     https://your-instance.example.com/api/enrichment/options

Методы аутентификации

МетодЗаголовокСценарий использования
Ключ APIX-API-Key: ent_...Межсервисное взаимодействие, CI/CD, автоматизация
Токен BearerAuthorization: Bearer <jwt>Веб-клиенты, интерактивные сессии
OAuth 2.1Authorization: Bearer <access_token>Коннекторы и AI-клиенты — отзываемое разрешение для каждого приложения, а не общий ключ

Доступ к эндпоинтам по ролям

Роль ключа API определяет, к каким конечным точкам он имеет доступ:

Категория эндпоинтаМинимальная роль
Обогащение (одиночное, пакетное)Оператор
Записи (список, сведения, удаление)Оператор
Схема (чтение)Оператор
Схема (создание, редактирование, удаление)Редактор
СлияниеОператор
Сведения о провайдереОператор
Аналитика стоимостиОператор
Управление ключами APIВладелец
Управление пользователямиВладелец

Управление ключами

Страница ключей API предоставляет полный обзор всех ключей организации со статистикой использования:

Посмотреть использованиеПросмотр времени последнего использования и общего количества использований для каждого ключа
Обновить рольИзменить роль ключа доступа организации (только для владельца)
ОтозватьНавсегда отключить ключ. Отозванные ключи нельзя активировать повторно.
Срок действияКлючи с истечением срока в течение 7 дней отмечаются. Просроченные ключи автоматически отклоняются.
  1. 1Роль меняется на месте, без перевыпуска ключа
  2. 2Отзыв вступает в силу немедленно и не может быть отменён
В столбце «Ключ» показан префикс, потому что только префикс и хранится: этого достаточно, чтобы отличить один ключ от другого в таблице и в журнале аудита, но бесполезно для того, кто попробует вызвать с ним API.

Ключи провайдера и ключи доступа

Страница «Ключи API» содержит пять вкладок с разным назначением — четыре доступны всем, плюс «Глобальные ключи» для системных администраторов:

  1. 1Собственные ключи LLM-провайдеров вашей организации
  2. 2Общий резервный пул — только для системных администраторов
  3. 3Ключи для вызова собственного API Entity Enricher
На первых двух вкладках хранятся ключи, с помощью которых Entity Enricher обращается к LLM; на последних трёх — учётные данные, с помощью которых другие системы обращаются к вашей организации. На странице об этом не сказано, но именно это направление определяет, на какой вкладке место ключу.

Ключи AI-провайдеров

API-ключи LLM-провайдеров вашей организации (Anthropic, OpenAI и др.) для независимой оплаты. Поддерживается несколько ключей на провайдера с автоматической LRU-ротацией; ключ, не прошедший проверку, выбывает из ротации до повторного теста или замены. О системе BYOK см. Модели и тарифы.

Ключи провайдера шифруются при хранении с помощью симметричного шифрования Fernet (AES-128-CBC с аутентификацией HMAC). Они расшифровываются только во время выполнения при вызовах API LLM. В открытом виде для отображения хранятся только последние 4 символа.

Глобальные ключи

Общесистемные ключи LLM-провайдеров, управляемые администраторами. Используются как резервные, когда ключ организации недоступен. Поддерживается несколько ключей на провайдера с ротацией LRU: следующим используется включённый ключ, который дольше всего не применялся, а ключ выходит из ротации, когда администратор отключает его или его проверка признаёт его недействительным. Если у провайдера нет пригодного ключа, запуск отклоняется, а не начинается.

Ключи доступа к приложению

Ключи доступа организации к собственному API Entity Enricher. Используются внешними системами для программного вызова эндпоинтов обогащения, схем, записей и других. Документацию по эндпоинтам см. в справочнике API.

Подключённые приложения

Приложения, которым вы выдали доступ через OAuth 2.1: каталог коннекторов claude.ai, Claude Desktop, подключения Make и n8n. Каждая строка — это отзываемое разрешение, а не общий секрет: отзыв здесь аннулирует токены этого приложения, не затрагивая остальные интеграции. Владельцы также могут зарегистрировать OAuth-клиент для self-hosted-экземпляра n8n.

Туннели Ollama

Учётные данные для самостоятельно настраиваемого туннеля Ollama, который открывает платформе доступ к локальному Ollama без открытия порта. См. руководство Ollama Tunnel.

  1. 1Кто выдал разрешение — доступ наследует роль этого участника
  2. 2Через какой интерфейс можно использовать токен: REST API, MCP или оба
  3. 3Отзыв одного приложения не затрагивает остальные подключения — они остаются авторизованными
Вкладка «Подключённые приложения»: по одной строке на каждое авторизованное приложение и участника, поэтому один и тот же человек может отдельно подключить claude.ai и экземпляр n8n. Столбец «Последнее использование» показывает, какой коннектор ещё работает, прежде чем вы его отзовёте.

Дальнейшие шаги