创建数字 LOA
数字授权书(LOA)可方便订购需要第三方 授权的服务。在处理 互连服务(如Cross Connect)的订单时,它最大限度地减少了A侧和Z侧的接洽。
本文档适用于创建数字授权书的z端合作伙伴。如果您是A侧合作伙伴寻求Z侧合作伙伴的数字授权书,请参阅申请数字授权书。
先决条件
-
身份验证 - 提交您的 OAuth2 用户凭据、客户端 ID 和客户端密钥 验证。有关如何致电OAuth API以验证和验证您的凭据的说明,请参阅API验证。
-
(可选)获取可能的A侧合作伙伴。使用获取可能的连接端点检索指定IBX数据中心中存在的A侧合作伙伴列表。
创建Digital LOA - 现有 A 方关系
要创建数字授权书,请向端点发送POST请求/diloa/v1/digitalLoas。在请求正文中指定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 |
向
获取可能的连接端点的GET请求响应中列出了您要向其颁发此数字授权书文档的A侧客户,请将参数设置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 方关系
要创建数字授权书,请向端点发送POST请求/diloa/v1/digitalLoas。在请求正文中指定连接详情。
您要向其颁发此Digital LOA文档的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参考手册。
授权使用Digital LOA
此步骤适用于新的A侧客户关系。数字授权书文档创建完毕后,A侧将收到包含授权链接的电子邮件通知。
A侧方验证并批准数字授权书文档后,向端点发送GET请求/diloa/v1/digitalLoas/{id}/actions。在请求路径中指定数字授权书,在请求正文中指定typeASAUTHORIZE。
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参考手册。
监控Digital LOA状态
使用/diloa/v1/digitalLoas/{id}API请求监控授权书文档状态。有关可能状态的信息,请参阅数字授权书状态。