Crear una LOA Digital
La carta de autorización digital (LOA) permite realizar pedidos cómodos de servicios que requieren autorización de terceros. Minimiza el compromiso tanto de A-Side como de Z-Side al procesar pedidos para servicios de interconexión como Cross Connect.
Este documento es para socios de z-Side que crean una LOA digital. Si es un socio de A-Side que busca una LOA digital de un socio de z-Side, consulte Solicitar una carta de autorización digital .
Requisitos previos
-
Autenticar - Envíe sus credenciales de usuario, ID de cliente y secreto de cliente para OAuth2 autenticación. Consulte Autenticación de API para obtener instrucciones sobre cómo llamar al API de OAuth para validar y autenticar sus credenciales.
-
(Opcional) Consiga posibles socios de A-Side. Utilice el punto finalObtener conexiones posibles para recuperar la lista de socios De A-Side que están presentes en un centro de datos IBX especificado.
Creación de un LOA digital: relación existente con la parte A
Para crear una LOA digital, envíe una POST solicitud al /diloa/v1/digitalLoas punto final. Especifique el socio de A-Side y los detalles de conexión en el cuerpo de la solicitud.
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 |
Si el cliente de A-Side al que desea emitir este documento de LOA digital aparece en la lista de
la respuesta a una solicitud GET al punto final GET POSIBLE CONNECTIONS, establezca el requestor.type parámetro en CUSTOMER_ORGANIZATION.
En el requestor.ids parámetro, especifique las organizaciones de clientes con derecho a utilizar este documento de LOA digital.
Ejemplo de solicitud 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"
}'
Los parámetros incluidos en el cuerpo de la solicitud son específicos de este ejemplo. Para obtener una lista completa de parámetros y sus descripciones, consulte la referencia de API .
Respuesta de muestra:
{
"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"
}
La carga útil de respuesta incluye parámetros de configuración definidos en el cuerpo de la solicitud. Para obtener una lista completa de los posibles parámetros y sus descripciones, consulte la Referencia de API .
Creación de un Digital LOA - Nueva relación A-side
Para crear una LOA digital, envíe una POST solicitud al /diloa/v1/digitalLoas punto final. Especifique los detalles de la conexión en el cuerpo de la solicitud.
Dado que el cliente de A-Side al que desea emitir este documento de LOA digital no aparece en la lista de
la respuesta a una solicitud GET en el punto final GET POSIBLE CONNECTIONS, establezca el requestor.type parámetro en NEW_RELATIONSHIP. Proporcione también su información de contacto.
Ejemplo de solicitud 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"
}'
Los parámetros incluidos en el cuerpo de la solicitud son específicos de este ejemplo. Para obtener una lista completa de parámetros y sus descripciones, consulte la referencia de API .
Autorizar el uso de Digital LOA
Este paso es aplicable a las nuevas relaciones con los clientes de A-Side. Una vez creado el documento de LOA digital, la parte de A-Side recibe una notificación por correo electrónico con un enlace de autorización.
Una vez que la parte de A-Side verifique y apruebe el documento de LOA digital, envíe una GET solicitud al /diloa/v1/digitalLoas/{id}/actions punto final. Especifique la LOA digital en la ruta de la solicitud y la type AS AUTHORIZE en el cuerpo de la solicitud.
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 |
Ejemplo de solicitud cURL:
curl -X
POST "https://api.equinix.com/diloa/v1/digitalLoas/{id}/actions"
-H "Authorization: Bearer <token>"
-d '{
"type": "AUTHORIZE"
}'
Los parámetros incluidos en el cuerpo de la solicitud son específicos de este ejemplo. Para obtener una lista completa de parámetros y sus descripciones, consulte la referencia de API .
Supervisión del estado de la LOA digital
Utilice la /diloa/v1/digitalLoas/{id}solicitud API para supervisar el estado del documento LOA. Para obtener información sobre posibles estados, consulte Estado de la LOA digital .