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 de forma programática 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 de Equinix Customer Portal o un proveedor de OIDC.
- Permisos de creación, modificación y eliminación específicos para cada producto.
Flujo de autorización de usuarios
-
Registre y autorice 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 obtener más información, consulte Autenticación API de OIDC .
El 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 la cabecera de autorización requerida.
-
La pasarela API valida la solicitud y llama a la API de Equinix correspondiente.
-
La respuesta es recibida por la pasarela API.
-
Se le devuelve la respuesta.
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 de terraformes de Equinix admite:
- Equinix Fabric - Conexiones virtuales, enrutadores en la nube, flujos y tiempo de precisión
- 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
El Equinix API está organizado 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 de API se proporcionan en formato opapi, que incluye información detallada sobre cada punto final, incluidos los formatos de solicitud y respuesta, los parámetros necesarios y las solicitudes de ejemplo. A lo largo de la documentación del producto de Equinix encontrará enlaces a la "Referencia de API" correspondiente al producto o servicio mencionado.
Para ver una biblioteca de todas las referencias de Equinix API por grupos funcionales, consulte el Catálogo de API . También puede encontrar enlaces a todas las referencias de Equinix API utilizando el siguiente árbol de navegación. Cada ruta de API principal está vinculada a su referencia de API correspondiente en esta vista.