整合指南

取得私密金鑰

使用新手上路介面

如要與 API 整合,您必須建立 Google Cloud 專案。然後,建立服務帳戶並取得私密金鑰。如要開始使用,請點選以下按鈕:

建立服務帳戶

手動產生金鑰

如果上述介面無法運作,請嘗試下列做法:

  1. 前往 Google Cloud Console
  2. 選擇要用來存取 API 的專案。
  3. 在左側的「IAM 與管理」選單中,找到服務帳戶並建立新服務帳戶,該帳戶將會是專案擁有者。
  4. 建立服務帳戶後,您應該會收到私密金鑰。

將服務帳戶加入許可清單

建立服務帳戶後:

  1. 聯絡 Google 帳戶擁有者,透過 mdp-support@google.com 與 GTAF 團隊聯絡。我們會將 Google 帳戶加入許可清單,以便存取 Mobile Data Plan Shared API 端點。
  2. 將服務帳戶與 Google ISP 入口網站上的電信業者建立關聯。電信業者可透過「API 存取權」進行關聯。

啟用程式庫

加入許可清單後:

  1. 前往 Google Cloud Console
  2. 請確認您已在頂端選單列的下拉式選單中,選取正確的專案。
  3. API 程式庫中啟用 Mobile Data Plan Shared API
  4. API 程式庫中啟用 Preprod Mobile Data Plan Shared API

測試 API 存取權

如要測試你的 Google 端存取權,請按照下列步驟操作:

  1. 安裝 oauth2l
  2. 取得服務帳戶的存取權杖,如下所示。your-service-account-key-file.json 是服務帳戶的金鑰檔案。

    > oauth2l fetch --json your-service-account-key-file.json dataplansharing
    

    請注意,存取權杖大約會在一小時後到期。針對新的存取權杖再次執行上述指令之前,請執行 oauth2l reset 以清除本機快取。

  3. 發出測試呼叫,如下所示。在整合期間設定 GTAF 時,YOUR-ASN 必須是您傳送給我們的 ASN。ACCESS-TOKEN-OBTAINED 是上述 oauth2l fetch 指令的輸出內容。PLAN_STATUS 是您要傳送至 GTAF 的 PlanStatus 要求主體。

    > url_domain="mobiledataplansharing.googleapis.com"
    > url_path="v1/operators/YOUR-ASN/clients/mobiledataplan/users/USER_KEY/planStatus"
    > curl -H "Content-Type: application/json" \
           -d 'PLAN_STATUS' \
           -X POST "https://$url_domain/$url_path?access_token=ACCESS-TOKEN-OBTAINED"
    

程式輔助 API 呼叫

按照操作說明,使用以下 OAuth 範圍向 Google 端方法進行授權呼叫:

https://www.googleapis.com/auth/dataplansharing

共用專案擁有權

雖然初始設定包含單一 Google 帳戶,但我們建議讓一組授權使用者取得專案的擁有權。在 Google Cloud Console 的「IAM 與管理」選單中,您可以將新成員 (包括 Google 群組帳戶) 新增為專案擁有者。