跳轉到
Megaport 技術文件
建立 API 金鑰
Copy for LLM ▼
Copy Page Content Open in ChatGPT Open in Claude Open in VS Code View Markdown
PDF

建立 API 金鑰

Megaport API 呼叫需要在建立 API 金鑰後產生的存取權杖。存取權杖用於驗證 API 使用者，並只允許在 Megaport Portal 中暫時存取所需的部分。

我們建議使用專用的機器對機器（M2M）Company Admin 帳戶來存取 Megaport API 並建立 API 金鑰。若人工作業的使用者遭停用或被鎖定無法登入其帳戶，該使用者所建立的 API 金鑰也會被停用，可能導致任何 API 整合停止運作。

API 金鑰僅在其產生的環境中有效。若您需要在不同環境中使用 API 金鑰，請登入該環境的 Megaport Portal 並在該環境中產生 API 金鑰。

備註

您必須以 Company Admin 身分登入 Megaport Portal 才能建立 API 金鑰。詳情請參閱 管理使用者角色。

本主題說明以下作業：

  • 在 Megaport Portal 中建立 API 金鑰
  • 在 Postman 產生存取權杖

在 Megaport Portal 中建立 API 金鑰

  1. 在 Megaport Portal 中，選擇 Tools > API Key Generator。
    API Keys 畫面可讓您建立 API 金鑰，並檢視與編輯現有的 API 金鑰。
    API Keys 畫面

  2. 指定 API 金鑰的詳細資料。

    • Name (名稱) – 輸入 API 金鑰的名稱。
      此名稱應具描述性，以利識別此金鑰的用途。

      備註

      • API 金鑰名稱至少需三個字元。

      • 除破折號與連字號之外，不允許使用特殊字元。

    • Role (角色) – 選取將使用 API 的使用者角色。
      可用的選項如下：

      • Company Admin
      • Read Only

    • Token Expiry (Minutes) (權杖到期時間（分鐘）) – 輸入由此金鑰產生之權杖在多少分鐘後到期。最短為 5 分鐘，最長為 24 小時（1440 分鐘）。權杖到期後，您需要重新產生新的存取權杖。

  3. 點擊 Generate Key (產生金鑰)。
    會建立 API 金鑰，並顯示 Your API Key 提示。
    Your API Key 提示

    重要

    複製您新的 API Key 與 API Key Secret，並將這些認證安全保存。您需要使用它們來產生存取權杖。請務必複製 API Key Secret，因為關閉此提示後將不會再次顯示。

  4. 點擊 Copy (複製)（在 API Key (API 金鑰) 欄位右側），並將此金鑰（Client Id）貼到安全的位置。

  5. 點擊 Copy (複製)（在 API Key Secret (API 金鑰密鑰) 欄位右側），並將 Client secret 貼到安全的位置。

  6. 點擊 關閉。
    API 金鑰會建立並顯示在畫面的 Active API Keys 區域。
    在 Active API Keys 區域中，您可以編輯金鑰名稱、刪除金鑰，以及檢視此金鑰的變更歷史記錄。

產生存取權杖

建立含有 client ID 與 client secret 的 API 金鑰後，您即可產生存取權杖來驗證 API 使用者。以下說明如何使用 Postman 與 Megaport 集合來完成此作業。關於 Postman 的設定細節，請參閱 Megaport API。

您需要使用的 Request URL 取決於您產生存取權杖的環境。在各環境中，請使用以下 Request URL：

  • 生產環境 – https://auth-m2m.megaport.com/oauth2/token
  • Staging（測試）環境 – https://auth-m2m-staging.megaport.com/oauth2/token

以下說明如何在生產環境中產生存取權杖。
如需更多資訊，請參閱 Megaport API 與 Megaport Authentication - API Keys。

備註

可呼叫哪些 API 端點取決於建立 API 金鑰時所選擇的角色。例如，Read Only API 金鑰在可存取的資料上會比 Company Admin API 金鑰有更多限制。

在 Postman 中產生存取權杖

  1. 在匯入的 Megaport Postman 集合中，點擊加號圖示以新增要求。
    新增要求
  2. 在 Request URL (要求 URL) 欄位左側的下拉式清單中，選取 POST。
    選取 POST 端點類型
  3. 在 Request URL (要求 URL) 欄位中，輸入以下 Request URL：
    https://auth-m2m.megaport.com/oauth2/token
    Request URL
  4. 選取 Authorization (授權) 分頁，並輸入以下參數詳細資料：
    • Username (使用者名稱) – 您先前在建立 API 金鑰時複製的 client ID。
    • Password (密碼) – 您先前在建立 API 金鑰時複製的 client secret。

    備註

    這些參數包含敏感資料。若您在協作環境中作業，建議將 client ID 與 client secret 分別設為變數 {{apiKeyClientId}} 與 {{apiKeyClientSecret}}。如需變數的相關資訊，請參閱 Postman 文件

    Access Token 端點授權參數

  5. 選取 Body (本文) 分頁，並新增名稱為 grant_type 的鍵，其值設為 client_credentials。
    Access Token 端點 Body 參數
  6. 點擊 儲存。
    會顯示 Save Request 畫面。
    Save Request 畫面
  7. 在 Request name (要求名稱) 欄位中，為新的要求輸入具意義的名稱。
    例如，Generate Access Token。
  8. （選用）輸入此要求的說明。
  9. 選取您要儲存此要求的位置，然後點擊 儲存。
    新的要求會建立並新增至 Megaport API Documentation 集合。

  10. 點擊 Send (傳送)。
    傳送存取權杖要求
    您應會收到包含存取權杖的回應，類似於下列範例。一旦產生存取權杖，即可用於在 Megaport Portal 的各個端點中驗證 API 使用者。

     {
  "access_token":  
      "eyJraWQ......2cOQGA",
  "expires_in": 86400,
  "token_type": "Bearer"
 }

  11. 複製存取權杖。

  12. 在此集合的變數中（點擊匯入的 Megaport 集合後方的三個點 > Edit > Variables），新增 access_token 條目，並將存取權杖貼到 CURRENT VALUE (目前值) 欄位。
  13. 對於您需要送出的每個 API 呼叫，在 Authorization (授權) 分頁中，將 Type 設為 Bearer Token，並將 Token 設為存取權杖變數 {{access_token}}。
    為 API 設定存取權杖
    API 呼叫已可使用。 所有 API 呼叫皆透過 SSL/TLS 傳輸，且每個呼叫都會依據存取權杖驗證其相應的權限。

備註

存取權杖會到期，因此您需要定期為 API 呼叫重新產生新的權杖。到期時間由建立 API 金鑰時在 Token Expiry (Minutes) (權杖到期時間（分鐘）) 欄位所輸入的值決定。預設到期時間為 24 小時。

API 要求包含兩個重要的標頭參數：Authorization 與 Content-Type。Authorization 參數對應到設定權杖變數的 Authorization 分頁。

必要標頭

使用 cURL 產生存取權杖

另一種產生存取權杖的方式是從命令列主控台使用 cURL，格式如下：

 curl -X "POST" "https://auth-m2m.megaport.com/oauth2/token" \
        -H 'Content-Type: application/x-www-form-urlencoded' \
        -u '<api_key>:<api_key_secret>' \
        --data-urlencode "grant_type=client_credentials"

提示

dev.megaport.com 網站可讓您以多種程式語言檢視每個 API 端點。