Passer au contenu principal

Créer une Digital LOA

La lettre d'autorisation numérique (LOA) permet de commander facilement des services nécessitant une autorisation tierce. Elle réduit l'engagement des deux côtés A et Z lors du traitement des commandes de services d'interconnexion tels que Cross Connect.

Ce document s'adresse aux partenaires z-Side qui créent une lettre d'autorisation numérique. Si vous êtes un partenaire a-Side à la recherche d'une lettre d'autorisation numérique auprès d'un partenaire z-Side, reportez-vous à la rubrique demande d'une lettre d'autorisation numérique .

Conditions préalables​

  1. Authentification - Soumettez vos identifiants utilisateur, votre identifiant client et votre clé secrète client pour OAuth2 authentification. Pour obtenir des instructions sur la façon d'appeler l'API OAuth pour valider et authentifier vos identifiants, reportez-vous à authentification API.

  2. (Facultatif) obtenir des partenaires A-Side possibles. Utilisez le point de terminaisonobtenir les connexions possibles pour récupérer la liste des partenaires A-Side présents dans un datacentre IBX spécifié.

Création d'une Digital LOA - Relation A-side existante​

Pour créer une lettre d'autorisation numérique, envoyez POSTune demande au /diloa/v1/digitalLoaspoint final. Dans le corps de la demande, spécifiez le partenaire a-Side et les détails de la connexion.

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

Si le client A-Side auquel vous souhaitez émettre ce document de lettre d’autorisation numérique est répertorié dans la réponse à une demande GET adressée au point de terminaison Get possible Connections, définissez le requestor.type paramètre sur CUSTOMER_ORGANIZATION.

Dans le requestor.ids paramètre, spécifiez les organisations clientes autorisées à utiliser ce document de lettre d'autorisation numérique.

Exemple de requête 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"  
}'

Les paramètres inclus dans le corps de la demande sont spécifiques à cet exemple. Pour obtenir la liste complète des paramètres et leurs descriptions, reportez-vous à la référence API .

Exemple de réponse:

{  
    "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 charge utile de réponse comprend les paramètres de configuration définis dans le corps de la demande. Pour obtenir la liste complète des paramètres possibles et leurs descriptions, reportez-vous à la référence API .

Création d'une Digital LOA - Nouvelle relation côté A​

Pour créer une lettre d'autorisation numérique, envoyez POSTune demande au /diloa/v1/digitalLoaspoint final. Spécifiez les détails de la connexion dans le corps de la demande.

Dans la mesure où le client A-Side auquel vous souhaitez émettre ce document de lettre d’autorisation numérique n’est pas répertorié dans la réponse à une demande GET adressée au point de terminaison Get possible Connections, définissez le requestor.type paramètre sur NEW_RELATIONSHIP. Indiquez également leurs coordonnées.

Exemple de requête 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"  
}'

Les paramètres inclus dans le corps de la demande sont spécifiques à cet exemple. Pour obtenir la liste complète des paramètres et leurs descriptions, reportez-vous à la référence API .

Autoriser l'utilisation de la Digital LOA​

Cette étape s'applique aux nouvelles relations client A-Side. Une fois le document de lettre d’autorisation numérique créé, la partie A-Side reçoit une notification par e-mail avec un lien d’autorisation.

Une fois que la partie A A vérifié et approuvé le document de lettre d'autorisation numérique, envoyez une GET demande au /diloa/v1/digitalLoas/{id}/actionsterminal. Indiquez la lettre d'autorisation numérique dans le chemin de la demande et le type AS AUTHORIZE dans le corps de la demande.

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

Exemple de requête cURL:

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

Les paramètres inclus dans le corps de la demande sont spécifiques à cet exemple. Pour obtenir la liste complète des paramètres et leurs descriptions, reportez-vous à la référence API .

Surveillance du statut de la Digital LOA​

Utilisez la /diloa/v1/digitalLoas/{id}demande API pour surveiller le statut du document de lettre d'autorisation. Pour plus d'informations sur les statuts possibles, consultez la section Statuts de lettre d'autorisation numérique .

Cette page vous a-t-elle été utile ?