La API de Equinix
Equinix™ proporciona un API HTTP REST REST al que se puede acceder en https://api.equinix.com/. En este documento se describe el API y cómo utilizarlo.
La API le permite interactuar mediante programación con sus recursos de Equinix, incluidos proyectos, dispositivos, conexiones, pedidos, despliegues de Colocation, tickets de asistencia y gestión de identidades y accesos.
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 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
-
Registrar y Autorizar una solicitud en el Portal del Cliente.
-
Solicite acceso y actualice la información del token llamando al teléfono
/oauth2/v1/tokencon la clave del consumidor, el secreto del consumidor y sus credenciales de usuario.
-
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
-
Cree un proveedor de OIDC en el portal del cliente o en el Equinix API.
-
Solicite acceso llamando al
/v1/tokenpunto final con su token de proveedor de identidad y alcance.
- Su solicitud devuelve el token de acceso de corta duración.
Para más información, consulte OIDC API Authentication.
Flujo de solicitudes
-
Utilizando un token de acceso OAuth válido para autorizar una solicitud, realice una llamada a un punto final de API con el encabezado de autorización requerido.
-
La pasarela API valida la solicitud y llama a la API de Equinix correspondiente.
-
La respuesta es recibida por la pasarela API.
-
La respuesta se le envía de vuelta.
Infraestructura como código con Terraform
Además del REST API, Equinix también proporciona un proveedor de terraformes que le permite gestionar los recursos de Equinix utilizando infraestructura como código. El proveedor de Terraform ajusta el Equinix API y proporciona una forma declarativa de definir y gestionar su infraestructura.
El proveedor Terraform de Equinix es compatible:
- Equinix Fabric - Conexiones virtuales, Cloud Routers, Streams y Precision Time
- Network Edge - Dispositivos de red virtual
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. En toda 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.