APIユーザー認証
Equinix APIは、OAuth 2.0プロトコルを使用して、APIエンドポイントへのリクエストを認証します。 Equinix APIとやり取りするには、ベアラアクセストークンが必要です。ベアラは認証方式の種類を決定し、OAuth 2.0プロトコルの一部です。
前提条件
API経由でエクイニクスの製品とやり取りするには、次のことが必要です:
- エクイニクスカスタマーポータル(ECP)アカウント。
- 製品固有の作成、変更、削除権限。組織のプライマリ管理者に連絡し、アクセス権限をリクエストしてください。
クライアントIDとクライアントシークレットの生成
APIリクエストを承認するトークンを取得するには、クライアントIDとクライアントシークレットが必要です。クライアントIDとクライアントシークレットを生成するには、カスタマーポータルの「_開発者設定」_セクションでアプリを登録してください。
アプリを登録するには
-
グローバルナビゲーションメニューから、[開発者設定]>[_アプリ]を_選択して、アプリの詳細を表示します。

-
APIライセンス契約 - 初めてプラットフォームとAPIを使用する前に、表示されるAPIライセンス契約を読み、同意する必要があります。

契約に同意すると、「_追加情報」_セクションで確認できます。

-
[新しいアプリを作成]をクリックします。

-
_アプリ名を_入力し、アプリ環境タイプ(プロダクション)を選択して、[作成]をクリックします。

-
アプリのタイルをクリックして詳細を開きます。
-
目のアイコンをクリックすると、コンシューマ_キー_とコンシューマシーク_レットが_表示されます。

アクセストークンのリクエスト
APIリクエストを承認するには、アクセストークンが必要です。トークンをリクエストするには、リクエストの本文にクライアントIDとクライアントシークレットを指定して、エンドポイントにリクエストを/oauth2/v1/token送信します。POST
cURLリクエストのサンプル:
curl -X
POST 'https://api.equinix.com/oauth2/v1/token'
-H 'content-type: application/json'
-d '{
"grant_type": "client_credentials",
"client_id": "<client_id>",
"client_secret": "<client_secret>"
}'
使用可能なパラメータとオプションの完全なリストについては、『APIリファレンス』を参照してください。
回答例
{
"access_token": "<token>",
"token_timeout": "3600",
"user_name": "john.doe@example.com",
"token_type": "Bearer"
}
トークンのリフレッシュ
エンドポイントにリクエストを/oauth2/v1/refreshaccesstoken送信することで、アクセストークンを更新できます。POST
サンプルcurlリクエスト:
curl -X
POST 'https://api.equinix.com/oauth2/v1/refreshaccesstoken'
-H 'content-type: application/json'
-d '{
"client_id": "<client_id>",
"client_secret": "<client_secret>",
"refresh_token": "<token>
}'
使用可能なパラメータとオプションの完全なリストについては、APIリファレンス
アクセストークンの使用
とやり取りするには、アクセストークンを次のようにEquinix APIリクエストの承認ヘッダーで送信します authorization: Bearer <token>
サンプルcURLリクエスト - コロケーションAPIからのインバウンド出荷:
curl -X
POST "https://api.equinix.com/colocations/v2/orders/shipments"
-H "content-type: application/json"
-H "authorization: Bearer <token>"
-d '{
"type": "INBOUND",
"requestedDateTime": "2020-11-02T10:45:41Z",
"cageId": "AM1:01:000111",
"details": {
"carrier": "CUSTOMER_CARRIER",
"numberOfBoxes": 2
}
}'