Commerce Portal API をアグリゲータとして使用する方法

Commerce Portal API を使用して、ユーザー、契約、月次請求書 (MBO)、および Cloud Services Provider との取引に関する情報を取得できます。Commerce Portal API を操作するには、Commerce Portal で API トークンを生成し、ベアラー トークンと交換します。

Commerce Portal API を使用して実行できる操作の詳細については、『Commerce Portal アグリゲータ API リファレンスおよびドキュメント』を参照してください。

API トークンを生成する方法

管理者ユーザーは、プロファイル設定で API トークンを生成します。

1. Commerce Portal ツールバーで、ユーザー名の横にあるドロップダウン メニューを展開し、[プロファイル] をクリックします。

2. [アクセス トークン] に移動し、[トークンの生成] をクリックします。

3. トークン名を入力し、有効期限とロールを選択してから、[生成] をクリックします。

4. 生成されたトークンをコピーまたは保存し、[閉じる] をクリックします。

トークンが生成され、有効なトークンのリストに表示されます。

トークンを取り消すか、有効期限を変更するには、[縦の省略記号] ボタン（）をクリックして、いずれかのオプションを選択します。

API トークンをベアラー トークンと交換する方法

Commerce Portal API に対して承認済みの要求を行う前に、API トークンをベアラー トークンと交換する必要があります。

認証 API を呼び出し、API トークンをベアラー トークンと交換します。

curl https://vcp.vmware.com/api/commerce/v1/auth \
-H 'Content-Type:application/json' \
-d '{"type":"UserToken","userToken":"yourAPIToken"}'

応答は、"accessToken" パラメータでベアラー トークンを返します。

{
 "tokenType":"bearer",
 "accessToken":"eyJhbGciOiJIUzUxMiJ9.
eyJhdWQiOiJTRVNTSU9OIiwiY29udGV4dCI6IjZmYWExZDM2LTE2NTUtNGY4Ny04ZWE3LWU0NGI0ZTM1MzQ2\
 MSIsImlhdCI6MTY1NDgzODc2NSwiZXhwIjoxNjU0ODQwNTY1fQ.
W9UCFRPNLpJK1JHKiBSODdjdyRqSBhq6jq7y5JkccmV5Gsw34zXrwiZcFECmhorvk5XW4Ow-1e0zGSR_if8AEQ",
 "expiresIn":1800
}

後続の API 要求でベアラー トークンを使用する方法

ベアラー トークンを取得したら、それを HTTP "Authorization" ヘッダーとして設定し、後続の API 要求を承認します。使用する正しい形式は "Authorization: Bearer your_accessToken" です。

次の例は、GET 要求でベアラー トークンがどのように使用されるかを示しています。

curl https://vcp.vmware.com/api/aggregator/v1/contracts \
-H "Accept: application/json" \
-H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhdWQiOiJTRVNTSU9OIiwiY29udGV4dCI6IjZmYWExZDM2LTE2NTUtNGY4Ny04ZWE3LWU0NGI0ZTM1MzQ2MSIsImlhdCI6MTY1NDgzODc2NSwiZXhwIjoxNjU0ODQwNTY1fQ.W9UCFRPNLpJK1JHKiBSODdjdyRqSBhq6jq7y5JkccmV5Gsw34zXrwiZcFECmhorvk5XW4Ow-1e0zGSR_if8AEQ"