Ir al contenido principal

La API de Equinix

Equinix™ provides a RESTful HTTP API which can be reached at https://api.equinix.com/. This document describes the API and how to use it.

La API le permite interactuar de forma programática con sus recursos de Equinix, incluidos proyectos, dispositivos, conexiones, pedidos, despliegues de Colocation, tickets de soporte y gestión de identidad y acceso.

Uso de la API de Equinix​

El uso de la API puede desglosarse en el flujo de autorización y el flujo de solicitud.

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

  • Cuenta del Equinix Customer Portal o de un proveedor de OIDC.
  • Permisos de creación, modificación y eliminación específicos para cada producto.

Flujo de autorización de usuarios​

  1. Registre y autorice una solicitud en el Portal del cliente.

  2. Request access and refresh token information by calling the /oauth2/v1/token with the Consumer key, Consumer secret, and your user credentials.

    Diagram of the user authorization flow showing a client application obtaining an OAuth access token and refresh token from the Equinix API

  3. Su solicitud le devuelve el token de acceso OAuth de corta duración y su token de actualización asociado.

Para obtener más información e instrucciones más detalladas, consulte Autenticación de API.

Flujo de autorización de tokens OIDC​

  1. Create an OIDC Provider in either the Customer Portal or the Equinix API.

  2. Request access by calling the /v1/token endpoint with your identity provider token and scope.

  1. Su solicitud devuelve el token de acceso de corta duración.

For more information, see OIDC API Authentication.

El flujo de solicitudes​

  1. Utilizando un token de acceso OAuth válido para autorizar una solicitud, realice una llamada a un punto final de API con la cabecera de autorización requerida.

    Diagram of the API request flow showing a client calling the API gateway, which forwards the request to Equinix APIs and returns the response

  2. La pasarela API valida la solicitud y llama a la API de Equinix correspondiente.

  3. La respuesta es recibida por la pasarela API.

  4. Se le devuelve la respuesta.

Infraestructura como código con Terraform​

Además de la API REST, Equinix también proporciona un Proveedor Terraform que le permite gestionar los recursos de Equinix utilizando la infraestructura como código. El proveedor Terraform envuelve la API de Equinix y proporciona una forma declarativa de definir y gestionar su infraestructura.

El proveedor Terraform de Equinix es compatible:

  • Equinix Metal - Servidores Bare Metal, redes e infraestructura
  • Equinix Fabric - Conexiones virtuales, Cloud Routers, Streams y Precision Time
  • Network Edge - Dispositivos de red virtuales

Para obtener documentación completa, ejemplos y recursos disponibles, consulte la Documentación del proveedor de Terraform.

Referencias API​

La API de Equinix está organizada en grupos funcionales versionados. Cada grupo funcional contiene un conjunto de puntos finales de API que le permiten realizar operaciones relacionadas con ese grupo.

Las referencias API se proporcionan en formato OpenAPI, que incluye información detallada sobre cada punto final, incluidos los formatos de solicitud y respuesta, los parámetros necesarios y solicitudes de ejemplo. A lo largo de la Documentación de productos Equinix encontrará enlaces a la "Referencia API" correspondiente al producto o servicio tratado.

Para ver una biblioteca de todas las referencias API de Equinix por grupos funcionales, consulte el Catálogo API. También puede encontrar enlaces a todas las Referencias API de Equinix utilizando el siguiente árbol de navegación. Cada ruta API principal está vinculada a su correspondiente Referencia API en esta vista.

No APIs found or available based on the current filters.

¿Fue útil esta página?