Criar uma Carta de Aceitação Digital
A Carta de Autorização Digital (LOA) permite a solicitação conveniente de serviços que exigem terceiros. autorização. Isso minimiza o envolvimento tanto do lado A quanto do lado Z ao processar pedidos para serviços de interconexão, como Cross Connect.
Este documento destina-se a parceiros do lado Z que criam uma Carta de Autorização Digital. Se você é um parceiro do lado A que busca uma Carta de Autorização Digital de um parceiro do lado Z, consulte Solicitar uma Carta de Autorização Digital.
Pré-requisitos
-
Autenticar - Envie suas credenciais de usuário, ID do cliente e segredo do cliente para OAuth2. autenticação. Consulte Autenticação de API para obter instruções sobre como chamar a API OAuth para validar e autenticar suas credenciais.
-
(Opcional) Obtenha possíveis parceiros do lado A. Use o endpoint Obter possíveis conexões para recuperar a lista de parceiros do lado A presentes em um data center IBX especificado.
Criando uma Digital LOA - Relacionamento A-side existente
Para criar uma Carta de Autorização Digital, envie uma solicitação POST para o endpoint /diloa/v1/digitalLoas. Especifique o parceiro do lado A e os detalhes da conexão no corpo da solicitação.
API specification for "diloav1" not found.
Se o cliente do lado A para o qual você deseja emitir este documento de LOA digital estiver listado na resposta
Para uma solicitação GET ao endpoint Obter possíveis conexões, defina o parâmetro requestor.type como CUSTOMER_ORGANIZATION.
No parâmetro requestor.ids, especifique as organizações de clientes autorizadas a usar este documento de LOA digital.
Exemplo de solicitação 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"
}'
Os parâmetros incluídos no corpo da solicitação são específicos deste exemplo. Para obter uma lista completa dos parâmetros e suas descrições, consulte a Referência da API.
Exemplo de resposta:
{
"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"
}
A resposta inclui parâmetros de configuração definidos no corpo da requisição. Para obter uma lista completa dos parâmetros possíveis e suas descrições, consulte a Referência da API.
Criando uma Digital LOA - Novo Relacionamento A-side
Para criar uma Carta de Autorização Digital, envie uma solicitação POST para o endpoint /diloa/v1/digitalLoas. Especifique os detalhes da conexão no corpo da solicitação.
Como o cliente do lado A para o qual você deseja emitir este documento de LOA digital não está listado na resposta,
Para uma solicitação GET ao endpoint Obter possíveis conexões, defina o parâmetro requestor.type como NEW_RELATIONSHIP. Forneça também as informações de contato.
Exemplo de solicitação 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"
}'
Os parâmetros incluídos no corpo da solicitação são específicos deste exemplo. Para obter uma lista completa dos parâmetros e suas descrições, consulte a Referência da API.
Autorizar o uso da Digital LOA
Esta etapa é aplicável a novos relacionamentos com clientes do lado A. Após a criação do documento de Digital LOA, a parte do lado A recebe uma notificação e-mail com um link de autorização.
Assim que a parte A verificar e aprovar o documento de Carta de Autorização Digital, envie uma solicitação GET para o endpoint /diloa/v1/digitalLoas/{id}/actions. Especifique a Carta de Autorização Digital no caminho da solicitação e o type como AUTHORIZE no corpo da solicitação.
API specification for "diloav1" not found.
Exemplo de solicitação cURL:
curl -X
POST "https://api.equinix.com/diloa/v1/digitalLoas/{id}/actions"
-H "Authorization: Bearer <token>"
-d '{
"type": "AUTHORIZE"
}'
Os parâmetros incluídos no corpo da solicitação são específicos deste exemplo. Para obter uma lista completa dos parâmetros e suas descrições, consulte a Referência da API.
Monitoramento do status da Digital LOA
Use a solicitação de API /diloa/v1/digitalLoas/{id} para monitorar o status do documento LOA. Para obter informações sobre os possíveis status, consulte Status do LOA Digital.