跳至内容

API 用户身份验证

Equinix API 使用 OAuth 2.0 协议对您向 API 端点发出的请求进行身份验证。 要与 Equinix API 交互，您需要一个持有者访问令牌。持有者令牌决定了身份验证方案的类型，它是 OAuth 2.0 协议的一部分。

信息

Equinix Metal API 不使用此处描述的身份验证流程。Metal API 密钥通过 Metal 控制台 进行管理，其身份验证在 API 参考 中有详细说明。

先决条件​

通过 API 与 Equinix 产品交互需要：

  • Equinix Customer Portal帐户。
  • 特定于产品的创建、修改和删除权限。请联系您组织的主要管理员并请求访问权限。

生成客户端 ID 和客户端密钥​

您需要客户端 ID 和客户端密钥才能获取授权 API 请求的令牌。要生成客户端 ID 和客户端密钥，请在客户门户的“开发者设置”部分注册您的应用。

要注册应用程序：

  1. 登录到客户门户。

  2. 从全局导航菜单中，选择“开发者设置”。 > Apps 显示应用详情。

  3. API 许可协议 - 在首次使用平台和 API 之前，您必须阅读并接受显示的 API 许可协议。

    一旦您接受了该协议，您可以在“附加信息”部分找到它。

  4. 点击创建新应用。

  5. 提供_应用名称_，选择_应用环境类型_（生产环境），然后单击创建。

  6. 单击您的应用程序图块以打开其详细信息。

  7. 点击眼睛图标查看您的_消费者密钥_和_消费者密钥_。

请求访问令牌​

您需要访问令牌才能授权您的 API 请求。要请求令牌，请向 /oauth2/v1/token 端点发送 POST 请求，并在请求正文中指定您的客户端 ID 和客户端密钥。

示例 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>"  
}'

有关可用参数和选项的完整列表，请参阅API 参考。

示例响应：

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

刷新令牌​

您可以通过向 /oauth2/v1/refreshaccesstoken 端点发送 POST 请求来刷新您的访问令牌。

示例 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>  
}'‌‌

有关可用参数和选项的完整列表，请参阅API 参考

使用访问令牌​

要与 Equinix API 交互，请在 HTTP 请求的 Authorization 标头中发送您的访问令牌，并加上 authorization: Bearer <token>

示例 cURL 请求 - 来自主机托管 API 的入站货运：

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  
    }  
}'‌
此页面有帮助吗？