APIキー - Entity Enricher ドキュメント

APIキー

Entity Enricherへのプログラムによるアクセス用にAPI keyを作成します。サービス間連携、CI/CDパイプライン、自動化ワークフローにはorganizationアクセスキーをご利用ください。

キーの種類

Entity Enricher は 2 種類の API キーをサポートしており、それぞれ異なるユースケースに適しています。

おすすめ

組織アクセスキー

どのユーザーアカウントにも紐づかず、独自のロールを持つスタンドアロンのキーです。サービス間連携に最適です。

  • 独自のロール(オーナー、編集者、オペレーター)を持ちます
  • ユーザーアカウントの変更の影響を受けません
  • 組織にスコープ設定されています
  • 作成にオーナー権限を必須にする

レガシーユーザーキー

特定のユーザーアカウントに紐付けられたキーです。作成者のロールを継承し、ユーザーアカウントの変更の影響を受けます。

  • 作成したユーザーのロールを継承する
  • ユーザーが無効化されると、そのキーは機能しなくなります
  • 認証済みのユーザーであれば誰でも作成できます

キーの形式とセキュリティ

形式:ent_a1b2c3d4e5f6g7h8

キーは ent_ プレフィックスの後にランダムなバイト列が続きます。完全なキーは作成時に一度だけ表示され、後から取得することはできません。

アクセスキー(Entity Enricher の API を呼び出すためのもの)はデータベースに SHA256 ハッシュとして保存されるため、データベースにアクセスできても元のキーを復元することはできません。識別のため、最初の 12 文字(プレフィックス)のみが平文で保存されます。

プロバイダーキー(Anthropic や OpenAI などの LLM API キー)は、Fernet 対称暗号(AES-128-CBC + HMAC)を使用して保存時に暗号化されます。LLM プロバイダーとの認証のため、実行時に復号可能である必要があります。プレーンテキストで保存されるのは末尾の4文字のみです。

APIキーを作成しています

キーはアプリケーションのAPI Keysページから、またはREST APIを使ってプログラムから作成します:

主な設定

フィールド説明
名前識別用のわかりやすい名前(例:「CI/CD Pipeline」「n8n Integration」)
ロール権限レベル:オーナー、エディター、またはオペレーター。キーがアクセスできる範囲を決定します。
スコープ読み取り、書き込み、またはその両方。キーがデータを変更できるか、読み取りのみできるかを制御します。
有効期限任意の有効期限。有効期限のないキーは取り消されるまで有効です。

API Keyの使用

すべてのリクエストで X-API-Key ヘッダーに API キーを含めて送信してください:

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>Web クライアント、対話型セッション
OAuth 2.1Authorization: Bearer <access_token>コネクタと AI クライアント — 共有キーではなく、アプリごとに取り消せる許可です

ロール別のエンドポイントアクセス

APIキーのロールによって、アクセスできるエンドポイントが決まります:

エンドポイントのカテゴリ最小ロール
エンリッチメント(単一、バッチ)演算子
レコード(一覧、詳細、削除)演算子
スキーマ(読み取り)演算子
スキーマ(作成、編集、削除)エディター
フュージョン演算子
プロバイダー情報演算子
コスト分析演算子
APIキー管理オーナー
ユーザー管理オーナー

キーの管理

APIキーページでは、すべての組織キーを使用統計とともに一覧で確認できます:

使用状況を表示各キーの最終使用タイムスタンプと合計使用回数を表示します
ロールを更新organization アクセスキーのロールを変更します(owner のみ)
取り消すキーを完全に無効化します。取り消されたキーは再有効化できません。
有効期限7日以内に有効期限が切れるキーにはフラグが付きます。期限切れのキーは自動的に拒否されます。

プロバイダーキーとアクセスキー

API Keys ページには、それぞれ用途の異なる5つのタブがあります:

プロバイダーキー

独立した課金のための organization の LLM provider API キー(Anthropic、OpenAI など)。provider ごとに複数のキーをサポートし、自動 LRU ローテーションを行います。BYOK システムについては Models & Pricing をご覧ください。

プロバイダーキーはFernet対称暗号化(HMAC認証付きAES-128-CBC)を使用して保存時に暗号化されます。LLM API呼び出しを行う実行時にのみ復号されます。表示目的で平文として保存されるのは末尾の4文字のみです。

グローバルキー

管理者が管理するシステム全体のLLMプロバイダーキーです。組織のキーが利用できない場合のフォールバックとして使用されます。プロバイダーごとに複数のキーを登録でき、LRU方式でローテーションします。有効なキーのうち最も長く使われていないものが次に使われ、キーがローテーションから外れるのは、管理者が手動で無効化したときだけです。

組織アクセスキー

Entity Enricher自身のAPIにアクセスするためのキーです。外部システムがエンリッチメント、スキーマ、レコード、その他のエンドポイントをプログラムから呼び出す際に使用します。エンドポイントのドキュメントについてはAPI Referenceをご覧ください。

連携アプリ

OAuth 2.1 で認可したアプリケーションです — claude.ai のコネクタディレクトリ、Claude Desktop、Make や n8n との接続などです。各行は共有シークレットではなく取り消し可能な許可です。ここで取り消すと、他の連携に影響を与えることなくそのアプリのトークンだけが無効になります。オーナーはセルフホストの n8n インスタンス用に OAuth クライアントを登録することもできます。

トンネル

ローカルの Ollama をポートを開放せずにプラットフォームへ公開する、セルフサービス型 Ollama トンネルの認証情報です。Ollama トンネルガイドをご覧ください。

次のステップ