Ir para o conteúdo principal

Autenticação de usuário da API

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

informações

A API Metal da Equinix não utiliza o fluxo de autenticação descrito aqui. As chaves da API Metal são gerenciadas através do console Metal, e sua autenticação está documentada na Referência da API.

Pré-requisitos​

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

  • Uma conta no Portal do Cliente da Equinix.
  • Permissões específicas do produto para criar, modificar e excluir. Entre em contato com o administrador principal da sua organização e solicite as permissões de acesso.

Gerar ID do cliente e segredo do cliente​

Um ID do Cliente e um Segredo do Cliente são necessários para obter os 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 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.

    Após aceitar o contrato, você poderá encontrá-lo na seção Informações Adicionais.

  4. Clique em Criar novo aplicativo.

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

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

  7. Clique no ícone do olho para visualizar sua Chave do Consumidor e 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 solicitação POST para o endpoint /oauth2/v1/token, especificando seu ID do Cliente e 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 da 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 solicitação POST para o endpoint /oauth2/v1/refreshaccesstoken.

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 da API

Utilizando tokens de acesso​

Para interagir com a API da Equinix, envie seu token de acesso no cabeçalho de Autorização da solicitar 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?