メインコンテンツまでスキップ

⚙️ APIキー

外部システム（eコマースプラットフォーム、サードパーティアプリ）がLKG for Billingの製品カタログやデータにアクセスできるようにするAPIキーを作成・管理します。

管理 → APIキー（設定内）に移動します。

注記

APIキーの管理には、設定で 外部API アクセス を有効にする必要があります。

概要​

APIキーは、外部アプリケーションがビジネスのAPIエンドポイントを呼び出すことを認可する認証情報です。各キーは、テストモードまたはライブモードにスコープ設定でき、レート制限を設定でき、特定のオリジンに制限できます。

表の列​

列説明
名前キーの表示名
モードテストまたはライブ
キーマスクされたキー — 末尾4文字のみ表示（例: ••••••••abcd）
レート制限1分あたりの最大APIリクエスト数
許可オリジンこのキーの使用が許可されているドメイン
ステータス有効または無効
有効期限キーの有効期限（設定されている場合）
操作コピー、再生成、有効/無効の切り替え、失効

APIキーの作成​

  1. + 新規APIキー をクリックします
  2. 以下を入力します：
フィールド必須説明
名前はいわかりやすいラベル（例: 「Shopify連携」）
モードはいテスト（サンドボックス）または ライブ（本番）
レート制限いいえ1分あたりの最大リクエスト数（制限なしの場合は空欄）
許可オリジンいいえこのキーの使用を許可するカンマ区切りのドメイン（例: shop.example.com）
説明いいえこのキーの用途に関するメモ
  1. 保存 をクリックします
  2. 完全なキーは一度だけ表示されます — すぐにコピーしてください
危険

完全なAPIキーは作成時に一度だけ表示されます。紛失した場合は、キーを再生成する必要があります（これにより古いキーは即座に失効します）。

キーのコピー​

行の コピー アイコンをクリックすると、マスクされたキーがコピーされます。完全なキーを再度取得するには、再生成 を使用してください。

キーの再生成​

  1. キーの行で 再生成 をクリックします
  2. 確認します — 古いキーは即座に失効します
  3. 新しい完全なキーが一度だけ表示されます — すぐにコピーしてください

有効/無効の切り替え​

有効 トグルをクリックすると、キーを削除せずに有効/無効を切り替えられます。無効なキーはAPIによって拒否されます。

キーの失効​

失効 をクリックすると、キーが完全に削除されます。この操作は元に戻せません。失効したキーを使用している連携は、即座にアクセスを失います。

セキュリティのベストプラクティス​

  • テスト環境と本番環境で別々のキーを使用する
  • 許可オリジン をアクセスが必要なドメインのみに制限する
  • 悪用を防ぐために レート制限 を設定する
  • 再生成 を使用して定期的にキーをローテーションする
  • 使用されなくなったキーは失効させる

関連トピック​