# 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[​](#utilizando-a-api-da-equinix "Link direto para 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[​](#fluxo-de-autorização-do-usuário "Link direto para Fluxo de autorização do usuário") 1. Cadastre e autorize um aplicativo no Portal do Cliente. 2. Solicite acesso e atualize as informações do token ligando para [`/oauth2/v1/token`](https://docs.equinix.com/pt-BR/api-catalog/accesstokenv1/oauth2-token/getoauth2accesstoken.md) com a chave do consumidor, o segredo do consumidor e suas credenciais de usuário. ![Diagrama do fluxo de autorização de usuário mostrando um aplicativo cliente obtendo um token de acesso OAuth e token de atualização do Equinix API](https://docs.equinix.com/pt-BR/assets/images/authorization-flow-968fdaa494b91626a4d3176b604cd49e.jpg) 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 API](https://docs.equinix.com/pt-BR/equinix-api/api-authentication.md) . ### Fluxo de autorização de token OIDC[​](#fluxo-de-autorização-de-token-oidc "Link direto para Fluxo de autorização de token OIDC") 1. [Crie um provedor de OIDC](https://docs.equinix.com/pt-BR/iam/oidc/create-oidc-provider.md) no Portal do Cliente ou no Equinix API. 2. Solicite acesso chamando o terminal com o `/v1/token`token e o escopo do provedor de identidade. 1. Sua solicitação retorna o token de acesso de curta duração. Para obter mais informações, consulte [Autenticação API do OIDC](https://docs.equinix.com/pt-BR/equinix-api/oidc-api-authentication.md) . ### Fluxo de Requisição[​](#fluxo-de-requisição "Link direto para 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. ![Diagrama do fluxo de solicitação API mostrando um cliente chamando o gateway API, que encaminha a solicitação para APIs Equinix e retorna a resposta](https://docs.equinix.com/pt-BR/assets/images/request-flow-1b070775deacbc1b9dc448520b67aef4.png) 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[​](#infraestrutura-como-código-com-terraform "Link direto para Infraestrutura como código com Terraform") Além da API REST, a Equinix também fornece um [provedor terraform](https://docs.equinix.com/pt-BR/terraform.md) 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](https://docs.equinix.com/pt-BR/terraform.md) . ## Referências da API[​](#referências-da-api "Link direto para 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](https://docs.equinix.com/pt-BR/api-catalog) . 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. 🔍 Filter APIs by name or path... api.equinix.com ├─ ► [billing](https://docs.equinix.com/pt-BR/api-catalog/basv2.md "Platform Billing Account APIs") [ (](https://docs.equinix.com/pt-BR/api-catalog/basv2.md "Platform Billing Account APIs") [Platform Billing Account APIs](https://docs.equinix.com/pt-BR/api-catalog/basv2.md "Platform Billing Account APIs") [)](https://docs.equinix.com/pt-BR/api-catalog/basv2.md "Platform Billing Account APIs") ├─ ▼ colocations │ └─ ▼ v2 │ ├─ [connectionServices](https://docs.equinix.com/pt-BR/api-catalog/lookupv2.md#tag/Lookup/operation/Retrieve%20list%20of%20connection%20services "Lookup") [ (](https://docs.equinix.com/pt-BR/api-catalog/lookupv2.md#tag/Lookup/operation/Retrieve%20list%20of%20connection%20services "Lookup") [Lookup](https://docs.equinix.com/pt-BR/api-catalog/lookupv2.md#tag/Lookup/operation/Retrieve%20list%20of%20connection%20services "Lookup") [)](https://docs.equinix.com/pt-BR/api-catalog/lookupv2.md#tag/Lookup/operation/Retrieve%20list%20of%20connection%20services "Lookup") │ ├─ [locations](https://docs.equinix.com/pt-BR/api-catalog/lookupv2.md#tag/Lookup/operation/Get%20Locations%20by%20permission%20code "Lookup") [ (](https://docs.equinix.com/pt-BR/api-catalog/lookupv2.md#tag/Lookup/operation/Get%20Locations%20by%20permission%20code "Lookup") [Lookup](https://docs.equinix.com/pt-BR/api-catalog/lookupv2.md#tag/Lookup/operation/Get%20Locations%20by%20permission%20code "Lookup") [)](https://docs.equinix.com/pt-BR/api-catalog/lookupv2.md#tag/Lookup/operation/Get%20Locations%20by%20permission%20code "Lookup") │ ├─ ▼ orders │ │ ├─ ► [{orderId}](https://docs.equinix.com/pt-BR/api-catalog/ordersv2.md "Orders") [ (](https://docs.equinix.com/pt-BR/api-catalog/ordersv2.md "Orders") [Orders](https://docs.equinix.com/pt-BR/api-catalog/ordersv2.md "Orders") [)](https://docs.equinix.com/pt-BR/api-catalog/ordersv2.md "Orders") │ │ ├─ ► [crossConnects](https://docs.equinix.com/pt-BR/api-catalog/crossconnectsv2.md "Cross Connect") [ (](https://docs.equinix.com/pt-BR/api-catalog/crossconnectsv2.md "Cross Connect") [Cross Connect](https://docs.equinix.com/pt-BR/api-catalog/crossconnectsv2.md "Cross Connect") [)](https://docs.equinix.com/pt-BR/api-catalog/crossconnectsv2.md "Cross Connect") │ │ ├─ ► [shipments](https://docs.equinix.com/pt-BR/api-catalog/shipmentsv2.md "Shipments") [ (](https://docs.equinix.com/pt-BR/api-catalog/shipmentsv2.md "Shipments") [Shipments](https://docs.equinix.com/pt-BR/api-catalog/shipmentsv2.md "Shipments") [)](https://docs.equinix.com/pt-BR/api-catalog/shipmentsv2.md "Shipments") │ │ └─ ► [workVisits](https://docs.equinix.com/pt-BR/api-catalog/workvisitsv2.md "Scheduling Work Visits") [ (](https://docs.equinix.com/pt-BR/api-catalog/workvisitsv2.md "Scheduling Work Visits") [Scheduling Work Visits](https://docs.equinix.com/pt-BR/api-catalog/workvisitsv2.md "Scheduling Work Visits") [)](https://docs.equinix.com/pt-BR/api-catalog/workvisitsv2.md "Scheduling Work Visits") │ ├─ ► [patchPanels](https://docs.equinix.com/pt-BR/api-catalog/lookupv2.md "Lookup") [ (](https://docs.equinix.com/pt-BR/api-catalog/lookupv2.md "Lookup") [Lookup](https://docs.equinix.com/pt-BR/api-catalog/lookupv2.md "Lookup") [)](https://docs.equinix.com/pt-BR/api-catalog/lookupv2.md "Lookup") │ ├─ [providers](https://docs.equinix.com/pt-BR/api-catalog/lookupv2.md#tag/Lookup/operation/Retrieve%20list%20of%20providers "Lookup") [ (](https://docs.equinix.com/pt-BR/api-catalog/lookupv2.md#tag/Lookup/operation/Retrieve%20list%20of%20providers "Lookup") [Lookup](https://docs.equinix.com/pt-BR/api-catalog/lookupv2.md#tag/Lookup/operation/Retrieve%20list%20of%20providers "Lookup") [)](https://docs.equinix.com/pt-BR/api-catalog/lookupv2.md#tag/Lookup/operation/Retrieve%20list%20of%20providers "Lookup") │ └─ [supportPlans](https://docs.equinix.com/pt-BR/api-catalog/supportplansv2.md#tag/Smart-Hands-Support-Plans/operation/Retrieve%20Smart%20Hands%20support%20plans "Smarthands Support Plans") [ (](https://docs.equinix.com/pt-BR/api-catalog/supportplansv2.md#tag/Smart-Hands-Support-Plans/operation/Retrieve%20Smart%20Hands%20support%20plans "Smarthands Support Plans") [Smarthands Support Plans](https://docs.equinix.com/pt-BR/api-catalog/supportplansv2.md#tag/Smart-Hands-Support-Plans/operation/Retrieve%20Smart%20Hands%20support%20plans "Smarthands Support Plans") [)](https://docs.equinix.com/pt-BR/api-catalog/supportplansv2.md#tag/Smart-Hands-Support-Plans/operation/Retrieve%20Smart%20Hands%20support%20plans "Smarthands Support Plans") ├─ ► [dcim](https://docs.equinix.com/pt-BR/api-catalog/smartviewv2.md "Equinix SmartView APIs") [ (](https://docs.equinix.com/pt-BR/api-catalog/smartviewv2.md "Equinix SmartView APIs") [Equinix SmartView APIs](https://docs.equinix.com/pt-BR/api-catalog/smartviewv2.md "Equinix SmartView APIs") [)](https://docs.equinix.com/pt-BR/api-catalog/smartviewv2.md "Equinix SmartView APIs") ├─ ► [diloa](https://docs.equinix.com/pt-BR/api-catalog/diloav1.md "Digital LOA API") [ (](https://docs.equinix.com/pt-BR/api-catalog/diloav1.md "Digital LOA API") [Digital LOA API](https://docs.equinix.com/pt-BR/api-catalog/diloav1.md "Digital LOA API") [)](https://docs.equinix.com/pt-BR/api-catalog/diloav1.md "Digital LOA API") ├─ ► [environment](https://docs.equinix.com/pt-BR/api-catalog/smartviewv2.md "Equinix SmartView APIs") [ (](https://docs.equinix.com/pt-BR/api-catalog/smartviewv2.md "Equinix SmartView APIs") [Equinix SmartView APIs](https://docs.equinix.com/pt-BR/api-catalog/smartviewv2.md "Equinix SmartView APIs") [)](https://docs.equinix.com/pt-BR/api-catalog/smartviewv2.md "Equinix SmartView APIs") ├─ ► [fabric](https://docs.equinix.com/pt-BR/api-catalog/fabricv4.md "Equinix Fabric API v4") [ (](https://docs.equinix.com/pt-BR/api-catalog/fabricv4.md "Equinix Fabric API v4") [Equinix Fabric API v4](https://docs.equinix.com/pt-BR/api-catalog/fabricv4.md "Equinix Fabric API v4") [)](https://docs.equinix.com/pt-BR/api-catalog/fabricv4.md "Equinix Fabric API v4") ├─ ▼ internetAccess │ ├─ ► [v1](https://docs.equinix.com/pt-BR/api-catalog/internetaccessv1.md "Equinix Internet Access API") [ (](https://docs.equinix.com/pt-BR/api-catalog/internetaccessv1.md "Equinix Internet Access API") [Equinix Internet Access API](https://docs.equinix.com/pt-BR/api-catalog/internetaccessv1.md "Equinix Internet Access API") [)](https://docs.equinix.com/pt-BR/api-catalog/internetaccessv1.md "Equinix Internet Access API") │ └─ ► [v2](https://docs.equinix.com/pt-BR/api-catalog/internetaccessv2.md "Equinix Internet Access API") [ (](https://docs.equinix.com/pt-BR/api-catalog/internetaccessv2.md "Equinix Internet Access API") [Equinix Internet Access API](https://docs.equinix.com/pt-BR/api-catalog/internetaccessv2.md "Equinix Internet Access API") [)](https://docs.equinix.com/pt-BR/api-catalog/internetaccessv2.md "Equinix Internet Access API") ├─ ► [ne](https://docs.equinix.com/pt-BR/api-catalog/network-edgev1.md "Network Edge APIs") [ (](https://docs.equinix.com/pt-BR/api-catalog/network-edgev1.md "Network Edge APIs") [Network Edge APIs](https://docs.equinix.com/pt-BR/api-catalog/network-edgev1.md "Network Edge APIs") [)](https://docs.equinix.com/pt-BR/api-catalog/network-edgev1.md "Network Edge APIs") ├─ ► [notifications](https://docs.equinix.com/pt-BR/api-catalog/unifiednotificationv2.md "Notifications API") [ (](https://docs.equinix.com/pt-BR/api-catalog/unifiednotificationv2.md "Notifications API") [Notifications API](https://docs.equinix.com/pt-BR/api-catalog/unifiednotificationv2.md "Notifications API") [)](https://docs.equinix.com/pt-BR/api-catalog/unifiednotificationv2.md "Notifications API") ├─ ► [oauth2](https://docs.equinix.com/pt-BR/api-catalog/accesstokenv1.md "Equinix API Authentication") [ (](https://docs.equinix.com/pt-BR/api-catalog/accesstokenv1.md "Equinix API Authentication") [Equinix API Authentication](https://docs.equinix.com/pt-BR/api-catalog/accesstokenv1.md "Equinix API Authentication") [)](https://docs.equinix.com/pt-BR/api-catalog/accesstokenv1.md "Equinix API Authentication") ├─ ► [power](https://docs.equinix.com/pt-BR/api-catalog/smartviewv2.md "Equinix SmartView APIs") [ (](https://docs.equinix.com/pt-BR/api-catalog/smartviewv2.md "Equinix SmartView APIs") [Equinix SmartView APIs](https://docs.equinix.com/pt-BR/api-catalog/smartviewv2.md "Equinix SmartView APIs") [)](https://docs.equinix.com/pt-BR/api-catalog/smartviewv2.md "Equinix SmartView APIs") ├─ ► [resourceManager](https://docs.equinix.com/pt-BR/api-catalog/getprojectsv2.md "Project APIs") [ (](https://docs.equinix.com/pt-BR/api-catalog/getprojectsv2.md "Project APIs") [Project APIs](https://docs.equinix.com/pt-BR/api-catalog/getprojectsv2.md "Project APIs") [)](https://docs.equinix.com/pt-BR/api-catalog/getprojectsv2.md "Project APIs") ├─ ► [securecabinet](https://docs.equinix.com/pt-BR/api-catalog/securecabinetv1.md "Secure Cabinet API") [ (](https://docs.equinix.com/pt-BR/api-catalog/securecabinetv1.md "Secure Cabinet API") [Secure Cabinet API](https://docs.equinix.com/pt-BR/api-catalog/securecabinetv1.md "Secure Cabinet API") [)](https://docs.equinix.com/pt-BR/api-catalog/securecabinetv1.md "Secure Cabinet API") ├─ ► [smartview](https://docs.equinix.com/pt-BR/api-catalog/smartviewv2.md "Equinix SmartView APIs") [ (](https://docs.equinix.com/pt-BR/api-catalog/smartviewv2.md "Equinix SmartView APIs") [Equinix SmartView APIs](https://docs.equinix.com/pt-BR/api-catalog/smartviewv2.md "Equinix SmartView APIs") [)](https://docs.equinix.com/pt-BR/api-catalog/smartviewv2.md "Equinix SmartView APIs") ├─ ► [support](https://docs.equinix.com/pt-BR/api-catalog/supportv2.md "Case Management API") [ (](https://docs.equinix.com/pt-BR/api-catalog/supportv2.md "Case Management API") [Case Management API](https://docs.equinix.com/pt-BR/api-catalog/supportv2.md "Case Management API") [)](https://docs.equinix.com/pt-BR/api-catalog/supportv2.md "Case Management API") └─ ▼ v2 ├─ ► [invoices](https://docs.equinix.com/pt-BR/api-catalog/billingv2.md "Billing APIs") [ (](https://docs.equinix.com/pt-BR/api-catalog/billingv2.md "Billing APIs") [Billing APIs](https://docs.equinix.com/pt-BR/api-catalog/billingv2.md "Billing APIs") [)](https://docs.equinix.com/pt-BR/api-catalog/billingv2.md "Billing APIs") ├─ ► [quotes](https://docs.equinix.com/pt-BR/api-catalog/quotesv2.md "Quote APIs") [ (](https://docs.equinix.com/pt-BR/api-catalog/quotesv2.md "Quote APIs") [Quote APIs](https://docs.equinix.com/pt-BR/api-catalog/quotesv2.md "Quote APIs") [)](https://docs.equinix.com/pt-BR/api-catalog/quotesv2.md "Quote APIs") └─ ► [tickets](https://docs.equinix.com/pt-BR/api-catalog/ticketsv2.md "Tickets") [ (](https://docs.equinix.com/pt-BR/api-catalog/ticketsv2.md "Tickets") [Tickets](https://docs.equinix.com/pt-BR/api-catalog/ticketsv2.md "Tickets") [)](https://docs.equinix.com/pt-BR/api-catalog/ticketsv2.md "Tickets")