APIキー
APIキー は LeadHub REST API へのプログラムアクセスを許可するベアラートークンです。カスタムインテグレーションの構築、他のシステムとのデータ同期、コードによるタスクの自動化に使用します。
APIキーの作成
- インテグレーション → APIキー に移動します。
- 新規APIキー をクリックします。
- 以下を入力します:
| フィールド | 説明 |
|---|---|
| 名前 | 説明的な名前（例: "マイアプリインテグレーション"、"Zapier"） |
| 権限 | このキーが実行できるアクション（読み取り専用、読み取り/書き込み） |
| 有効期限 | オプションの有効期限日。空白の場合は無期限 |
- 保存 をクリックします。
- トークンをすぐにコピーしてください — 一度だけ表示されます。紛失した場合は再生成が必要です。
APIキーの使用
すべてのAPIリクエストにベアラートークンとしてキーを含めます:
GET /api/leads HTTP/1.1
Host: yourdomain.com
Authorization: Bearer YOUR_API_KEY_HERE
Content-Type: application/json
APIエンドポイント
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /api/leads | すべてのリードを一覧表示（ページネーション付き） |
GET | /api/leads/{id} | 単一リードを取得 |
POST | /api/leads | 新規リードを作成 |
PUT | /api/leads/{id} | リードを更新 |
DELETE | /api/leads/{id} | リードを削除 |
GET | /api/pipelines | パイプラインを一覧表示 |
GET | /api/tags | タグを一覧表示 |
POST | /api/leads/{id}/tags | リードにタグを追加 |
完全なAPIリファレンスは、インストール環境の /api/documentation にある LeadHub Swagger ドキュメントで確認できます。
キーの失効
APIキーを失効させるには:
- インテグレーション → APIキー に移動します。
- キーの行の削除アイコンをクリックして確認します。
キーは即座に無効化されます。このキーを使用したリクエストは401 Unauthorizedレスポンスを受け取ります。
セキュリティのベストプラクティス
- APIキーをバージョン管理（GitHub、Bitbucketなど）にコミットしないでください
- データの読み取りだけが必要な場合は読み取り専用キーを使用してください
- 一時的なインテグレーションに使用するキーには有効期限を設定してください
- キーが漏洩した可能性がある場合は直ちに失効さ せてください
- インテグレーションごとに1つのキーを使用して、個別に失効できるようにしてください