A API da 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 da Equinix, incluindo projetos, dispositivos, conexões, pedidos, implantações de colocation, chamados de suporte e gerenciamento de identidade e acesso.
Utilizando a API da Equinix
A utilização da API pode ser dividida em fluxo de autorização e fluxo de requisição.
A interação com os produtos Equinix por meio da 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
-
Cadastre e autorize um aplicativo 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 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 API do OIDC .
Fluxo de Requisição
-
Utilizando um token de acesso OAuth válido para autorizar uma solicitação, faça uma chamada para um endpoint da API com o cabeçalho de autorização necessário.
-
O gateway de API valida a solicitação e chama a API relevante da Equinix.
-
A resposta é recebida pelo gateway da API.
-
A resposta será enviada 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 de cloud, fluxos e tempo de precisão
- Network Edge - Dispositivos de rede virtual
Para obter a documentação completa, exemplos e recursos disponíveis, consulte a Documentação do Provedor terraform .
Referências da API
O Equinix API é organizado em grupos funcionais com controle de versão. Cada grupo funcional contém um conjunto de terminais API que permitem que você execute operações relacionadas a esse grupo.
As referências API são fornecidas no formato OpenAPI, que inclui informações detalhadas sobre cada terminal, incluindo os formatos de solicitação e resposta, parâmetros necessários e exemplos de solicitações. Em toda a Documentação do Produto Equinix, você encontrará links para a "Referência API" correspondente ao produto ou serviço discutido.
Para ver uma biblioteca de todas as Referências Equinix API por Grupos Funcionais, consulte o Catálogo API . Você também pode encontrar links para todas as Referências Equinix API usando a seguinte árvore de navegação. Nesta visualização, cada caminho API principal está vinculado à sua referência API correspondente.