API のセットアップ

IBM® Key Protect for IBM Cloud® が提供する REST API を使用すると、任意のプログラミング言語を使用して、暗号鍵の保管、取得、および生成を行うことができます。

IBM Cloud 資格情報の取得

API で作業するには、サービス資格情報と認証資格情報を生成する必要があります。

資格情報を収集するには、次のようにします。

API 要求の作成

サービスへの API 呼び出しを行う場合は、以下のインスタンスを最初にプロビジョンした方法に従って API 要求を構成します。 Key Protect.

要求を作成するには、サービス・エンドポイントと適切な認証資格情報を組み合わせます。例えば、次のリージョンの Key Protect インスタンスを作成した場合は (us-south リージョン)、以下のエンドポイントと API ヘッダーを使用してサービスの鍵を参照します。

$ curl -X GET \
    "https://us-south.kms.cloud.ibm.com/api/v2/keys" \
    -H "accept: application/vnd.ibm.collection+json" \
    -H "authorization: Bearer <IAM_token>" \
    -H "bluemix-instance: <instance_ID>"

<access_token> と <instance_ID> を、リトリーブしたサービスと認証資格情報に置き換えます。

何か問題が起こった場合に API 要求を追跡する必要があるときは、 -v 要求の一部として curl フラグを組み込むと、応答ヘッダーに correlation-id 値が含まれます。この値を使用して、デバッグ目的で、要求の相互関連付けおよび追跡を行うことができます。

次のステップ

次の方法で暗号鍵の管理を開始する準備が整いました。 Key Protect. 鍵をプログラムで管理する方法について詳しくは、Key Protect API リファレンス資料を参照してください。