Créer un Digital LOA
La Digital Letter of Authorization (LOA) permet de commander facilement des services nécessitant l'autorisation d'un tiers. Elle minimise l'engagement du côté A et du côté Z lors du traitement des commandes de services d'interconnexion tels que Cross-Connect.
Ce document est destiné aux partenaires côté z qui créent une Digital LOA. Si vous êtes un partenaire a-side cherchant à obtenir une Digital LOA d'un partenaire z-side, consultez Request a Digital Letter of Authorization.
Conditions préalables
-
Authentifier - Soumettez vos informations d'identification, votre ID client et votre secret client pour OAuth2. authentification. Reportez-vous à API Authentication pour savoir comment appeler l'API OAuth afin de valider et d'authentifier vos informations d'identification.
-
(En option) Obtenez des partenaires potentiels du côté A. Utilisez le point de terminaison Get Possible Connections pour récupérer la liste des partenaires côté A présents dans un centre de données IBX spécifié.
Création d'une Digital LOA - Relation existante avec la partie A
Pour créer une Digital LOA, envoyez une requête POST au point de terminaison /diloa/v1/digitalLoas. Spécifiez le partenaire a-side et les détails de la connexion dans le corps de la requête.
API specification for "diloav1" not found.
Si le client côté A auquel vous souhaitez délivrer ce document Digital LOA est répertorié dans la réponse à une requête GET au point de terminaison Get Possible Connections, définissez le paramètre requestor.type sur CUSTOMER_ORGANIZATION.
Dans le paramètre requestor.ids, indiquez les organisations clientes habilitées à utiliser ce document Digital LOA.
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 requête sont spécifiques à cet exemple. Pour obtenir la liste complète des paramètres et leur description, consultez 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 la 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 leur description, consultez la Référence API.
Création d'un Digital LOA - Nouvelle relation A-side
Pour créer une Digital LOA, envoyez une requête POST au point de terminaison /diloa/v1/digitalLoas. Spécifiez les détails de la connexion dans le corps de la requête.
Étant donné que le client côté A auquel vous souhaitez délivrer ce document Digital LOA n'est pas répertorié dans la réponse à une requête GET au point de terminaison Get Possible Connections, définissez le paramètre requestor.type 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 requête sont spécifiques à cet exemple. Pour obtenir la liste complète des paramètres et leur description, consultez la Référence API.
Autoriser l'utilisation du Digital LOA
Cette étape s'applique aux nouvelles relations avec les clients du côté A. Après la création du document Digital LOA, la partie côté A reçoit une notification par courriel avec un lien d'autorisation.
Une fois que la partie côté A a vérifié et approuvé le document Digital LOA, envoyez une requête GET au point de terminaison /diloa/v1/digitalLoas/{id}/actions. Spécifiez le Digital LOA dans le chemin de la requête et le type comme AUTHORIZE dans le corps de la requête.
API specification for "diloav1" not found.
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 requête sont spécifiques à cet exemple. Pour obtenir la liste complète des paramètres et leur description, consultez la Référence API.
Contrôle de l'état du Digital LOA
Utilisez la requête API /diloa/v1/digitalLoas/{id} pour contrôler le statut du document LOA. Pour plus d'informations sur les statuts possibles, voir Digital LOA Statuses.