APIキーの作成と管理

APIキーは、REST APIを介して動的リモート設定コンテンツにアクセスするために必要です。
APIキーは、作成された環境のコンテンツのみにアクセスできます。
Joystickでは、すべての環境のAPIエンドポイントは同じです。APIキーを変更すると、どの環境からコンテンツが取得されるかが決まります。以下の例では、"config-a"を取得するために同じエンドポイントが使用されていますが、キーが異なるため、DEVは"v1"のコンテンツを取得し、PRODは"v9"のコンテンツを取得します。コンテンツのバージョン管理の詳細については、設定コンテンツの管理を参照してください。

Tip

各コード環境（例：Dev、QA、Staging、Production）に対してJoystickで環境を作成し、別々のAPIキーを提供することをおすすめします。

APIキー管理への移動

製品のすべての環境を表示しているとき、APIキーを作成/管理したい環境を選択します。

環境内にいるとき、"Environment API Keys"タブをクリックします。

既存のAPIキーを表示したり、取り消したり、新しいAPIキーを作成したりすることができます。

"Create API Key for..."ボタンをクリックしてダイアログを表示します。APIキーの目的に関するわかりやすい名前を入力し、"Create API Key"をクリックします。
APIキーが作成された後、完全なAPIキーは一度だけ表示されます。APIキーを安全な場所に保存してください。このAPIキーは保存されず、アクセスすることはできません。APIキーを失った場合、新しいものを生成する必要があります。

タイプ	説明
読み取り専用	読み取り専用のキーは、作成された環境の任意の動的リモート設定コンテンツをリクエストおよび取得することができます。
読み書き	読み書きのAPIキーは、アクセス可能な環境での設定の新しいリビジョンを作成する権限があります。これを使用して、APIを介してコンテンツを自動的/プログラム的に更新することができます。APIでのコンテンツの更新を希望する場合は、当社のチームにお問い合わせください。

APIキーを取り消すと、すぐに無効になります。それを使用して行われた後続のAPIリクエストは、401 Unauthorizedを返します。APIキーの取り消しは元に戻すことができません。取り消すキーがもう使用されていないことを確認してください。