A API Equinix
O Equinix(TM) fornece um API HTTP RESTful que pode ser acessado em https://api.equinix.com/. Este documento descreve o API e como usá-lo.
A API permite que você interaja programaticamente com seus recursos Equinix, incluindo projetos, dispositivos, conexões, pedidos, implantações de colocation, tickets de suporte e gerenciamento de Identidade e acesso.
Usando a API Equinix
A utilização da API pode ser dividida em fluxo de autorização e fluxo de requisição.
A interação com produtos Equinix via API requer:
- Conta no Portal do Cliente Equinix ou um Provedor OIDC.
- Permissões específicas do produto para criar, modificar e excluir itens.
Fluxo de autorização do usuário
-
Registre e autorize um pedido no Portal do Cliente.
-
Solicite acesso e atualize as informações do token ligando para
/oauth2/v1/tokencom a chave do consumidor, o segredo do consumidor e suas credenciais de usuário.
-
Sua solicitação retorna o token de acesso OAuth de curta duração e o token de atualização associado.
Para obter mais informações e instruções mais detalhadas, consulte Autenticação de API.
Fluxo de autorização de token OIDC
-
Crie um provedor de OIDC no Portal do Cliente ou no Equinix API.
-
Solicite acesso chamando o terminal com o
/v1/tokentoken e o escopo do provedor de identidade.
- Sua solicitação retorna o token de acesso de curta duração.
Para obter mais informações, consulte Autenticação da API OIDC.
O fluxo de solicitação
-
Usando um token de acesso OAuth válido para autorizar uma solicitação, faça uma chamada para um ponto de extremidade da API com o cabeçalho de autorização necessário.
-
O gateway de API valida a solicitação e chama a API Equinix relevante.
-
A resposta é recebida pelo gateway da API.
-
A resposta é enviada de volta para você.
Infraestrutura como código com Terraform
Além da API REST, a Equinix também fornece um provedor terraform que permite gerenciar recursos Equinix usando a infraestrutura como código. O provedor terraform envolve o Equinix API e fornece uma maneira declarativa de definir e gerenciar sua infraestrutura.
O provedor Terraform da Equinix oferece suporte a:
- Equinix Fabric - Conexões virtuais, roteadores em nuvem, fluxos de dados e tempo de precisão.
- Network Edge - Dispositivos de rede virtual
Para obter documentação completa, exemplos e recursos disponíveis, consulte a Documentação do provedor Terraform.
Referências de API
A API Equinix é organizada em grupos funcionais versionados. Cada grupo funcional contém um conjunto de endpoints de API que você executar operações relacionadas a esse grupo.
As referências de API são fornecidas no formato OpenAPI, que inclui informações detalhadas sobre cada endpoint, incluindo os formatos de solicitar e resposta, parâmetros necessários e exemplos de solicitações. Ao longo da Documentação do Produto Equinix, você encontrará links para a "Referência de API " correspondente ao produto ou serviço em questão.
Para visualizar uma biblioteca de todas as Referências de API da Equinix por grupos funcionais, consulte o Catálogo de APIs. Você também pode encontrar links para todas as Referências de API da Equinix usando a seguinte árvore de navegação. Cada caminho de API principal está vinculado à sua Referência de API correspondente nesta visualização.