API キーの作成
アプリケーションが IBM® X-Force® Exchangeなどのプラットフォーム・サービスと直接通信できるようにするには、API キーを指定する必要があります。
このタスクについて
API キーは 2 つの部分からなるストリングで、固有 ID と秘密トークンで構成され、API エンドポイントへの認証に使用されます。 固有 ID はユーザー ID に相当し、それに関連付けられた ID に固有のアクセス権のセットを持ちます。 パスワードに相当する秘密トークンは、API に対する呼び出しプロセスの ID を検証するために、固有 ID とともに使用されるコードです。
重要:
鍵の安全性を維持するために、90 日後に鍵を削除して、新しく作成してください。
手順
- ホーム・ページで、 「メニュー」 アイコンをクリックします。
- 「一般設定」の下で、 「API キー」 をクリックし、 「API キーの作成」をクリックします。
- 「API キー名」 フィールドに、キーを識別する固有の分かりやすい名前を入力します。
- 「生成」をクリックします。
結果
鍵が作成されると、 「API 鍵の作成 (Create API key)」 ペインに API 鍵の詳細が表示されます。固有 ID と秘密トークンが割り当てられます。
重要: 「完了」をクリックした後は、秘密トークンを取得できません。 鍵の詳細を安全な場所に格納するには、鍵コードと秘密トークンをテキスト・ファイル (
.txt) にコピーするか、ダウンロードします。API キーの表示
「API キー」 ページから既存の API キーのリストを表示できます。
手順
- ホーム・ページで、 「メニュー」 アイコンをクリックします。
- 「一般設定」で、 「API キー」をクリックします。
- 「API キー」 ページで、作成した既存のキーの詳細を確認できます。 各キーの値の行には、指定した名前と、割り当てられた固有 ID が含まれます。 「最終変更日時」には、作成日または鍵の名前を変更した直近の日付が含まれています。
API キーの削除
必要なくなった API キーの削除は簡単に行えます。
手順
- ホーム・ページで、 「メニュー」 アイコンをクリックします。
- 「一般設定」で、 「API キー」をクリックします。
- 削除対象の鍵が含まれる行にカーソルを移動します。
- 削除アイコンをクリックします。
- 「削除」をクリックします。