本文へスキップ

デジタルLOAの作成

Digital Letter of Authorization (LOA)は、第三者認証を必要とするサービスの便利な注文を可能にします。これにより、Cross-Connectなどの相互接続サービスの注文を処理する際に、AサイドとZサイドの両方からの関与が最小限に抑えられます。

この文書は、Digital LOAを作成するサイド・パートナー向けです。ZサイドパートナーからのDigital LOAを求めるAサイドパートナーの方は、Request a Digital Letter of Authorizationをご覧ください。

必須条件​

  1. 認証 - OAuth2用のユーザー認証情報、クライアントID、クライアントシークレットを送信します。 認証を使用します。OAuth APIを呼び出して認証情報を検証および認証する方法については、API認証を参照してください。

  2. (Optional) 可能性のあるAサイドパートナーを取得します。Get Possible Connectionsエンドポイントを使用して、指定したIBXデータセンターに存在するAサイドパートナーのリストを取得します。

デジタル LOA の作成 - 既存の A 側との関係​

Digital LOA を作成するには、/diloa/v1/digitalLoas エンドポイントに POST リクエストを送信します。リクエストの本文で、a 側のパートナーと接続の詳細を指定します。

POST /diloa/v1/digitalLoasView the API Reference
MethodPOST
URL or End Point/diloa/v1/digitalLoas
HeadersContent-Type
Query ParametersNot applicable
Body Parametersproducts [{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

Get Possible ConnectionsエンドポイントへのGETリクエストのレスポンスに、このDigital LOA文書を発行したいA側顧客がリストされている場合、requestor.typeパラメータにCUSTOMER_ORGANIZATIONを設定します。

requestor.ids`パラメータに、このDigital LOA文書を使用する権利を持つ顧客組織を指定します。

サンプル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 サイドの関係​

Digital LOA を作成するには、/diloa/v1/digitalLoas エンドポイントに POST リクエストを送信します。リクエストの本文に接続の詳細を指定します。

Get Possible ConnectionsエンドポイントへのGETリクエストのレスポンスに、このDigital LOA文書を発行したいA側の顧客がリストされていないため、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側顧客関係に適用されます。Digital LOA文書が作成されると、A側当事者は認証リンクが記載された電子メール通知を受け取ります。

A 側の当事者が Digital LOA ドキュメントを検証して承認したら、/diloa/v1/digitalLoas/{id}/actions エンドポイントに GET リクエストを送信します。リクエストのパスに Digital LOA を指定し、リクエスト本文に type を AUTHORIZE と指定します。

POST /diloa/v1/digitalLoas/{uuid}/actionsView the API Reference
MethodPOST
URL or End Point/diloa/v1/digitalLoas/{uuid}/actions
HeadersContent-Type
Query ParametersNot applicable
Body Parameterstype

サンプルcURLリクエスト：

curl -X  
POST "https://api.equinix.com/diloa/v1/digitalLoas/{id}/actions"  
-H "Authorization: Bearer <token>"  
-d '{  
    "type": "AUTHORIZE"  
}'

リクエストボディに含まれるパラメータは、この例に特有のものです。パラメータの完全なリストとその説明については、APIリファレンスを参照してください。

デジタルLOAステータスの監視​

LOA ドキュメントのステータスを監視するには、/diloa/v1/digitalLoas/{id} API リクエストを使用してください。可能なステータスについては、Digital LOA Statusesを参照してください。

このページは役に立ちましたか？