Créer un LOA numérique
La lettre d'autorisation numérique (LOA) permet de commander facilement des services nécessitant l'intervention d'un tiers. autorisation. Cela minimise l'intervention des parties A et Z lors du traitement des commandes. services d'interconnexion tels que Cross Connect.
Ce document s'adresse aux partenaires z qui créent une lettre d'autorisation numérique. Si vous êtes un partenaire a et que vous souhaitez obtenir une lettre d'autorisation numérique auprès d'un partenaire z, veuillez consulter Demander une lettre d'autorisation numérique.
Préalable
-
Authentification - Soumettez vos identifiants utilisateur, votre identifiant client et votre clé secrète client pour OAuth2 Authentification. Consultez Authentification API pour obtenir des instructions sur la façon d'appeler l'API OAuth afin de valider et d'authentifier vos informations d'identification.
-
(Optionnel) Obtenir les partenaires A potentiels. Utilisez le point de terminaison Obtenir les connexions possibles pour récupérer la liste des partenaires A présents dans un centre de données IBX spécifié.
Création d'une Digital LOA - Relation A-side existante
Pour créer un contrat de prêt numérique (Loa Digital), envoyez une requête POST au point de terminaison /diloa/v1/digitalLoas. Spécifiez le partenaire côté A et les détails de connexion dans le corps de la requête.
API specification for "diloav1" not found.
Si le client A auquel vous souhaitez remettre ce document LOA numérique figure dans la réponse
à une requête GET au point de terminaison Get Possible Connections, définissez le paramètre requestor.type à CUSTOMER_ORGANIZATION.
Dans le paramètre requestor.ids, précisez les organisations clientes autorisées à utiliser ce document LOA 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 requête sont propres à cet exemple. Pour obtenir la liste complète des paramètres et leurs descriptions, consultez la référence de l'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 inclut les paramètres de configuration définis dans le corps de la requête. Pour obtenir la liste complète des paramètres possibles et leurs descriptions, consultez la référence de l'API.
Création d'une Digital LOA - Nouvelle relation côté A
Pour créer un LOA numérique, envoyez une requête POST au point de terminaison /diloa/v1/digitalLoas. Précisez les détails de connexion dans le corps de la requête.
Étant donné que le client A auquel vous souhaitez livrer ce document LOA numérique ne figure pas dans la réponse
Lors d'une requête GET adressée au point de terminaison Get Possible Connections, définissez le paramètre requestor.type sur NEW_RELATIONSHIP. Veuillez également fournir 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 propres à cet exemple. Pour obtenir la liste complète des paramètres et leurs descriptions, consultez la référence de l'API.
Autoriser l'utilisation de la Digital LOA
Cette étape s'applique aux nouvelles relations clients côté A. Une fois le document Digital LOA créé, la partie côté A reçoit une notification par e-mail contenant un lien d'autorisation.
Une fois que la partie 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 propres à cet exemple. Pour obtenir la liste complète des paramètres et leurs descriptions, consultez la référence de l'API.
Surveillance du statut de la Digital LOA
Utilisez la requête API /diloa/v1/digitalLoas/{id} pour suivre l'état des documents LOA. Pour plus d'informations sur les états possibles, consultez la page États des documents LOA numériques.