Ir al contenido principal

Autenticación de usuarios API

Las API de Equinix utilizan el protocolo OAuth 2.0 para autenticar las solicitudes que realiza a los puntos finales de las API. Para interactuar con las API de Equinix, necesita un token de acceso de portador. El portador determina el tipo de esquema de autenticación y forma parte del protocolo OAuth 2.0.

información

La API Equinix Metal no utiliza el flujo de autenticación descrito aquí. Las claves de la API Metal se gestionan a través de la consola Metal, y su autenticación está documentada en la Referencia de la API.

Requisitos previos​

Interactuar con los productos de Equinix a través de API requiere:

  • Una cuenta de Equinix Customer Portal.
  • Permisos de creación, modificación y eliminación específicos para cada producto. Póngase en contacto con el administrador principal de su organización y solicite los permisos de acceso.

Generar ID de cliente y secreto de cliente​

Un ID de cliente y un Secreto de cliente son necesarios para obtener tokens que autoricen sus solicitudes API. Para generar un ID de cliente y un secreto de cliente, registre su aplicación en la sección Configuración del desarrollador del Portal del cliente.

Para registrar una aplicación:

  1. Acceda al Customer Portal.

  2. En el menú de navegación global, seleccione Configuración del desarrollador > Aplicaciones para ver los detalles de la aplicación.

  3. Acuerdo de licencia API - Antes de utilizar la plataforma y las API por primera vez, debe leer y aceptar el acuerdo de licencia API que se muestra.

    Una vez que haya aceptado el acuerdo, podrá encontrarlo en la sección Información adicional.

  4. Haga clic en Crear nueva aplicación.

  5. Proporcione un nombre de aplicación, seleccione tipo de entorno de aplicación (Producción) y haga clic en Crear.

  6. Haga clic en el mosaico de su aplicación para abrir sus detalles.

  7. Haga clic en el icono del ojo para ver su Clave de Consumidor y su Secreto de Consumidor.

Solicitar un token de acceso​

Se necesita un token de acceso para autorizar sus solicitudes de API. Para solicitar un token, envíe una solicitud POST al punto final /oauth2/v1/token, especificando su ID de cliente y su secreto de cliente en el cuerpo de la solicitud.

Ejemplo de solicitud cURL:

curl -X  
POST 'https://api.equinix.com/oauth2/v1/token'  
-H 'content-type: application/json'  
-d '{  
    "grant_type": "client_credentials",  
    "client_id": "<client_id>",  
    "client_secret": "<client_secret>"  
}'

Para obtener una lista completa de los parámetros y opciones disponibles, consulte la Referencia API.

Respuesta de muestra:

{  
    "access_token": "<token>",  
    "token_timeout": "3600",  
    "user_name": "john.doe@example.com",  
    "token_type": "Bearer"  
}

Actualizar un token​

Puede actualizar su token de acceso enviando una solicitud POST al punto final /oauth2/v1/refreshaccesstoken.

Ejemplo de solicitud curl:

curl -X  
POST 'https://api.equinix.com/oauth2/v1/refreshaccesstoken'  
-H 'content-type: application/json'  
-d '{  
    "client_id": "<client_id>",  
    "client_secret": "<client_secret>",  
    "refresh_token": "<token>  
}'‌‌

Para obtener una lista completa de los parámetros y opciones disponibles, consulte la Referencia API

Uso de tokens de acceso​

To interact with Equinix API, send your access token in the Authorization header of the HTTP request with authorization: Bearer <token>

Ejemplo de solicitud cURL: un envío entrante desde la API de Colocation:

curl -X  
POST "https://api.equinix.com/colocations/v2/orders/shipments"  
-H "content-type: application/json"  
-H "authorization: Bearer <token>"  
-d '{  
    "type": "INBOUND",  
    "requestedDateTime": "2020-11-02T10:45:41Z",  
    "cageId": "AM1:01:000111",  
    "details": {  
    "carrier": "CUSTOMER_CARRIER",  
    "numberOfBoxes": 2  
    }  
}'‌
¿Fue útil esta página?