Ir para o conteúdo principal

Autenticação de usuário da API

As APIs Equinix usam o protocolo OAuth 2,0 para autenticar as solicitações que você faz aos terminais API. Para interagir com as APIs Equinix, você precisa de um token de acesso ao portador. O portador determina o tipo de esquema de autenticação e faz parte do protocolo OAuth 2,0.

Pré-requisitos​

A interação com os produtos Equinix por meio da API requer:

  • Uma conta no Portal do Cliente da Equinix.
  • Permissões de criação, modificação e exclusão específicas do produto. Contate o administrador principal da sua organização e solicite permissões de acesso.

Gerar ID do cliente e segredo do cliente​

Um ID de cliente e um segredo de cliente são necessários para obter tokens que autorizam suas solicitações de API. Para gerar um ID do cliente e um segredo do cliente, registre seu aplicativo na seção Configurações do desenvolvedor do Portal do cliente.

Para registrar um aplicativo:

  1. Faça login no Portal do Cliente .

  2. No menu de navegação global, selecione Configurações do desenvolvedor > Aplicativos para exibir os detalhes do aplicativo.

  3. Contrato de Licença da API - Antes de usar a plataforma e as APIs pela primeira vez, você deve ler e aceitar o contrato de licença da API exibido.

    Depois de aceitar o contrato, você pode encontrá-lo na seção Informações adicionais.

  4. Clique em Criar novo aplicativo.

  5. Forneça um nome de aplicativo , selecione o tipo de ambiente de aplicativo (produção) e clique em Criar.

  6. Clique no ícone do seu aplicativo para abrir os detalhes.

  7. Clique no ícone de olho para ver sua Chave do Consumidor e o Segredo do Consumidor .

Solicitação de um token de acesso​

É necessário um token de acesso para autorizar suas solicitações API. Para solicitar um token, envie uma POST solicitação ao /oauth2/v1/tokenterminal, especificando seu ID do cliente e o segredo do cliente no corpo da solicitação.

Exemplo de requisição cURL:

curl -X
POST 'https://api.equinix.com/oauth2/v1/token'
-H 'content-type: application/json'
-d '{
"grant_type": "client_credentials",
"client_id": "<client_id>",
"client_secret": "<client_secret>"
}'

Para obter uma lista completa dos parâmetros e opções disponíveis, consulte a Referência do API .

Exemplo de resposta:

{
"access_token": "<token>",
"token_timeout": "3600",
"user_name": "john.doe@example.com",
"token_type": "Bearer"
}

Atualizando um token​

Você pode atualizar seu token de acesso enviando uma POST solicitação ao /oauth2/v1/refreshaccesstokenterminal.

Exemplo de requisição curl:

curl -X
POST 'https://api.equinix.com/oauth2/v1/refreshaccesstoken'
-H 'content-type: application/json'
-d '{
"client_id": "<client_id>",
"client_secret": "<client_secret>",
"refresh_token": "<token>
}'‌‌

Para obter uma lista completa dos parâmetros e opções disponíveis, consulte a Referência do API

Utilizando tokens de acesso​

Para interagir com o Equinix API, envie seu token de acesso no cabeçalho de autorização da solicitação HTTP com authorization: Bearer <token>

Exemplo de requisição cURL - um envio recebido da API de colocation:

curl -X
POST "https://api.equinix.com/colocations/v2/orders/shipments"
-H "content-type: application/json"
-H "authorization: Bearer <token>"
-d '{
"type": "INBOUND",
"requestedDateTime": "2020-11-02T10:45:41Z",
"cageId": "AM1:01:000111",
"details": {
"carrier": "CUSTOMER_CARRIER",
"numberOfBoxes": 2
}
}'‌
Esta página foi útil?