デジタルLOAの作成
デジタル承認書(LOA)を使用すると、サードパーティの 承認が必要なサービスを簡単に発注できます。 Cross Connectなどの相互接続サービスのオーダーを処理する際に、AサイドとZサイドの両方からのエンゲージメントを最小限に抑えます。
このドキュメントは、デジタル承認書を作成するZサイドパートナーを対象としています。Zサイドパートナーからデジタル承認書を申請しているAサイドパートナーの場合は、「デジタル承認書をリクエストする」を参照してください。
前提条件
-
認証 - OAuth2用のユーザー認証情報、クライアントID、クライアントシークレットを送信します。 認証。認証情報を検証および認証するためにOAuth APIを呼び出す方法については、「API認証」を参照してください。
-
(任意)Aサイドパートナー候補を取得します。Get Possible Connectionsエンドポイントを使用して、指定されたIBXデータセンターに存在するAサイドパートナーのリストを取得します。
デジタル LOA の作成 - 既存の A 側との関係
デジタル承認書を作成するには、エンドポイントにリクエストを/diloa/v1/digitalLoas送信します。POSTリクエストの本文でAサイドパートナーと接続の詳細を指定します。
POST /diloa/v1/digitalLoasView the API Reference | |
|---|---|
| Method | POST |
| URL or End Point | /diloa/v1/digitalLoas |
| Headers | Content-Type |
| Query Parameters | Not applicable |
| Body Parameters | products [{type, crossConnect {connectionService, mediaType, protocolType, aSide {connectorType, circuitId, patchPanelId, portA, portB}, zSide {connectorType, circuitId, patchPanelId, portA, portB}}}], requestor {type}, provider {contacts [{type, registeredUser, firstName, lastName, timezone, availability, details [{notes, value, type}]}]}, notes, expiryDateTime |
このデジタル承認書を発行したいAサイドの顧客が、「
接続可能取得」エンドポイントへのGETリクエストへの応答にリストされている場合は、パラメータをに設定します。requestor.type``CUSTOMER_ORGANIZATION
パラメータで、requestor.idsこのデジタル承認書を使用する権利がある顧客組織を指定します。
サンプルcURLリクエスト:
curl -X
POST "https://api.equinix.com/diloa/v1/digitalLoas"
-H "content-type: application/json"
-H "Authorization: Bearer <token>"
-d '{
"products": [
{
"type": "CROSS_CONNECT",
"crossConnect": {
"connectionService": "UTP",
"mediaType": "CAT6",
"protocolType": "ETHERNET",
"zSide": {
"connectorType": "RJ45",
"patchPanelId": "PP:0000:6256843",
"circuitId": "34234535",
"portA": 4
}
}
}
],
"requestor": {
"type": "CUSTOMER_ORGANIZATION",
"contacts": [
{
"type": "NOTIFICATION",
"details": [
{
"value": "jane@xyz.com",
"type": "EMAIL"
}
]
}
],
"orgIds": [
"123412",
"223124"
],
"name": "XYZ Company"
},
"provider": {
"contacts": [
{
"type": "NOTIFICATION",
"firstName": "John",
"lastName": "Smith",
"timezone": "America/Los_Angeles",
"details": [
{
"value": "john@smith.com",
"type": "EMAIL"
}
]
}
]
},
"notes": "",
"expiryDateTime": "2022-07-31T21:59:59.999Z"
}'
リクエスト本文に含まれるパラメータは、この例に固有のものです。パラメータの完全なリストとその説明については、APIリファレンスを参照してください。
回答例
{
"token": "<token>",
"uuid": "079dc798-05e8-11ed-b939-0242ac120002",
"state": "READY_FOR_USE",
"draft": false,
"changeLog": {
"createdDateTime": 2018-05-24T18:19:59.999Z
},
"link": {
"rel": "info",
"href": "https://ic-core-prod-ingress-usw1.clouda.equinix.com:80/diloa/v2/digitalLoas/402cbf99-97d7-440f-8291-1a4b9639154a",
"method": "GET",
"contentType": "application/json",
"authenticate": true
},
"expiryDateTime": 2018-06-24T18:19:59.999Z,
"href": "diloa/v1/digitalLoas/079dc798-05e8-11ed-b939-0242ac120002"
}
応答ペイロードには、リクエスト本文で定義された構成パラメータが含まれます。使用可能なパラメータの全リストとその説明については、APIリファレンスを参照してください。
Digital LOA の作成 - 新しい A サイドの関係
デジタル承認書を作成するには、エンドポイントにリクエストを/diloa/v1/digitalLoas送信します。POSTリクエストの本文で接続の詳細を指定します。
このデジタル承認書を発行するAサイドの顧客は、
接続可能な取得エンドポイントへのGETリクエストへの応答にリストされていないため、パラメータをに設定します。requestor.type``NEW_RELATIONSHIP連絡先情報も提供してください。
サンプルcURLリクエスト:
curl -X
POST "https://api.equinix.com/diloa/v1/digitalLoas"
-H "content-type: application/json"
-H "Authorization: Bearer {Access Token}"
-d '{
"products": [
{
"type": "CROSS_CONNECT",
"crossConnect": {
"connectionService": "UTP",
"mediaType": "CAT6",
"protocolType": "ETHERNET",
"zSide": {
"connectorType": "RJ45",
"patchPanelId": "PP:0000:6256843",
"circuitId": "34234535",
"portA": 4
}
}
}
],
"requestor": {
"type": "NEW_RELATIONSHIP",
"email": "jane@xyz.com",
"name": "XYZ Company"
},
"provider": {
"contacts": [
{
"type": "NOTIFICATION",
"firstName": "John",
"lastName": "Smith",
"timezone": "America/Los_Angeles",
"details": [
{
"value": "john@smith.com",
"type": "EMAIL"
}
]
}
]
},
"notes": "",
"expiryDateTime": "2022-07-31T21:59:59.999Z"
}'
リクエスト本文に含まれるパラメータは、この例に固有のものです。パラメータの完全なリストとその説明については、APIリファレンスを参照してください。
デジタルLOAの使用許可
このステップは、新しいAサイドのお客様との関係に適用されます。デジタル承認書ドキュメントが作成されると、Aサイド当事者は承認リンクが記載されたメール通知を受信します。
Aサイド当事者がデジタル承認書ドキュメントを確認して承認したら、エンドポイントにリクエストを/diloa/v1/digitalLoas/{id}/actions送信します。GETリクエストのパスにデジタル承認書を指定し、リクエストの本文にASをAUTHORIZE指定します。type
POST /diloa/v1/digitalLoas/{uuid}/actionsView the API Reference | |
|---|---|
| Method | POST |
| URL or End Point | /diloa/v1/digitalLoas/{uuid}/actions |
| Headers | Content-Type |
| Query Parameters | Not applicable |
| Body Parameters | type |
サンプルcURLリクエスト:
curl -X
POST "https://api.equinix.com/diloa/v1/digitalLoas/{id}/actions"
-H "Authorization: Bearer <token>"
-d '{
"type": "AUTHORIZE"
}'
リクエスト本文に含まれるパラメータは、この例に固有のものです。パラメータの完全なリストとその説明については、APIリファレンスを参照してください。
デジタルLOAステータスの監視
APIリクエストを使用して、/diloa/v1/digitalLoas/{id}承認書ドキュメントのステータスを監視します。考えられるステータスについては、デジタル承認書ステータスを参照してください。