APIユーザー認証

エクイニクスのAPIは、OAuth 2.0プロトコルを使用してAPIエンドポイントへのリクエストを認証します。 エクイニクスのAPIを利用するには、ベアラアクセストークンが必要です。ベアラは認証スキームの種類を決定するもので、OAuth 2.0プロトコルの一部です。

インフォメーション

Equinix Metal APIは、ここで説明する認証フローを使用しません。Metal APIキーはMetalコンソールで管理され、その認証についてはAPIリファレンスに記載されています。

必須条件

API経由でエクイニクスの製品を利用するには、以下の手順が必要です：

• エクイニクスカスタマーポータル（ECP）アカウント。
• 製品固有の作成、変更、削除権限。組織のプライマリ管理者に連絡し、アクセス許可をリクエストしてください。

クライアントIDとクライアントシークレットの生成

クライアントIDとクライアントシークレットは、APIリクエストを承認するトークンを取得するために必要です。クライアントIDとクライアントシークレットを生成するには、カスタマーポータルの_Developer Settings_セクションでアプリを登録します。

アプリを登録するには

1. カスタマーポータルにサインインしてください。

2. グローバルナビゲーションメニューから、Developer Settings > _Apps_を選択し、アプリの詳細を表示します。

   

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

   

   ご契約に同意されましたら、_Additional Information_セクションでご確認いただけます。

   

4. Create New App をクリックします。

   

5. アプリ名_をプロバイダで指定し、アプリ環境タイプ（Production）を選択して、Create をクリックします。

   

6. アプリのタイルをクリックして詳細を開きます。

7. 目のアイコンをクリックすると、_Consumer Key_と_Consumer Secret_が表示されます。

   

アクセストークンのリクエスト

APIリクエストを承認するには、アクセストークンが必要です。トークンをリクエストするには、/oauth2/v1/token エンドポイントに POST リクエストを送信し、リクエスト本文に Client ID と Client Secret を指定します。

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 リファレンス を参照してください。

アクセストークンの使用

To interact with Equinix API, send your access token in the Authorization header of the HTTP request with 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  
    }  
}'‌