Ir para o conteúdo principal

A API da Equinix

A Equinix™ fornece uma API HTTP RESTful que pode ser acessada em https://api.equinix.com/. Este documento descreve a API e como usá-la.

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​

  1. Cadastre e autorize um aplicativo no Portal do Cliente.

  2. Solicite informações de token de acesso e atualização chamando /oauth2/v1/token com a chave do consumidor, o segredo do consumidor e suas credenciais de usuário .

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

  3. 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​

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

  2. Solicite acesso chamando o endpoint /v1/token com seu token de provedor de identidade e escopo.

  1. Sua solicitação retorna o token de acesso de curta duração.

Para obter mais informações, consulte Autenticação da API OIDC.

Fluxo de Requisição​

  1. 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.

    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. O gateway de API valida a solicitação e chama a API relevante da Equinix.

  3. A resposta é recebida pelo gateway da API.

  4. 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 da Equinix usando infraestrutura como código. O provedor Terraform encapsula a API da Equinix e fornece uma maneira declarativa de definir e gerenciar sua infraestrutura.

O provedor Terraform da Equinix oferece suporte a:

  • Equinix Metal - Servidores bare metal, redes e infraestrutura
  • Equinix Fabric - Conexões virtuais, roteadores em nuvem, fluxos de dados e tempo de precisão.
  • Borda da Rede - Dispositivos de rede virtuais

Para obter documentação completa, exemplos e recursos disponíveis, consulte a Documentação do provedor Terraform.

Referências da API​

A API da Equinix está organizada em grupos funcionais versionados. Cada grupo funcional contém um conjunto de endpoints da API que permitem realizar operações relacionadas a esse grupo.

As referências da API são fornecidas no formato OpenAPI, que inclui informações detalhadas sobre cada endpoint, incluindo os formatos de requisição e resposta, parâmetros obrigatórios e exemplos de requisições. Ao longo da Documentação de Produtos da Equinix, você encontrará links para a "Referência da 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.

No APIs found or available based on the current filters.

Esta página foi útil?