Ir para o conteúdo principal

Criar uma Carta de Aceitação Digital

A carta de autorização digital (LOA) permite o pedido conveniente de serviços que exigem autorização de terceiros. Ele minimiza o envolvimento do A-Side e Z-Side ao processar pedidos de serviços de interconexão, como Cross Connect.

Este documento é para parceiros z-Side que criam uma LOA digital. Se você for um parceiro A-Side que busca uma LOA Digital de um parceiro z-Side, consulte Solicitar uma Carta de Autorização Digital .

Pré-requisitos​

  1. Autenticar - Envie suas credenciais de usuário, ID do cliente e segredo do cliente para OAuth2. autenticação. Consulte Autenticação API para obter instruções sobre como chamar o OAuth API para validar e autenticar suas credenciais.

  2. (Opcional) Obtenha possíveis parceiros A-Side. Use o endpointObter conexões possíveis para recuperar a lista de parceiros A-Side que estão presentes em um data center IBX especificado.

Criando uma Digital LOA - Relacionamento A-side existente​

Para criar uma LOA digital, envie uma POST solicitação para o /diloa/v1/digitalLoas terminal. Especifique os detalhes do parceiro A-Side e da conexão no corpo da solicitação.

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

Se o cliente A-Side para o qual você deseja emitir este documento LOA Digital estiver listado na resposta a uma solicitação GET para o endpoint GET Possíveis Conexões, defina o requestor.type parâmetro como CUSTOMER_ORGANIZATION.

No requestor.idsparâmetro, especifique as organizações do cliente com direito a usar este documento 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 de parâmetros e suas descrições, consulte a Referência 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"  
}

O payload de resposta inclui parâmetros de configuração definidos no corpo da solicitação. Para obter uma lista completa dos parâmetros possíveis e suas descrições, consulte a Referência API .

Criando uma Digital LOA - Novo Relacionamento A-side​

Para criar uma LOA digital, envie uma POST solicitação para o /diloa/v1/digitalLoas terminal. Especifique os detalhes da conexão no corpo da solicitação.

Como o cliente A-Side para o qual você deseja emitir este documento LOA Digital não está listado na resposta a uma solicitação GET para o endpoint GET Possíveis Conexões, defina o requestor.type parâmetro como NEW_RELATIONSHIP. Também forneça suas 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 de parâmetros e suas descrições, consulte a Referência API .

Autorizar o uso da Digital LOA​

Esta etapa é aplicável a novos relacionamentos com clientes A-Side. Após a criação do documento da LOA Digital, a parte A-Side recebe uma notificação por e-mail com um link de autorização.

Depois que a parte A-Side verificar e aprovar o documento da LOA Digital, envie uma GET solicitação para o /diloa/v1/digitalLoas/{id}/actions terminal. Especifique a LOA Digital no caminho da solicitação e o AS AUTHORIZEno corpo da solicitaçãotype.

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

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 de parâmetros e suas descrições, consulte a Referência API .

Monitoramento do status da Digital LOA​

Use a /diloa/v1/digitalLoas/{id}solicitação API para monitorar o status do documento LOA. Para obter informações sobre possíveis status, consulte Status da LOA digital .

Esta página foi útil?