整合指南

取得私密金鑰

使用新手上路介面

如要整合 API,您必須建立 Google Cloud 專案。接著建立服務帳戶並取得私密金鑰。如要開始使用,請按一下下列按鈕:

建立服務帳戶

手動產生金鑰

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

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

將服務帳戶加入許可清單

建立服務帳戶後:

  1. 請使用專案擁有者的 Google 帳戶,透過 mdp-support@google.com 與 GTAF 團隊聯絡。我們會將 Google 帳戶加入許可清單,允許存取 Mobile Data Plan Sharing API 端點。
  2. Google ISP 入口網站上,將服務帳戶與電信業者建立關聯。如要建立關聯,請前往「API 存取」

啟用程式庫

完成許可清單設定後,請按照下列步驟操作:

  1. 前往 Google Cloud Console
  2. 請確認已在頂端選單列的下拉式選單中選取正確的專案。
  3. API 程式庫中啟用 Mobile Data Plan Sharing API
  4. API 程式庫中啟用「Preprod Mobile Data Plan Sharing 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. 請按照下列步驟發出測試呼叫。YOUR-ASN 必須是您在整合過程中設定 GTAF 時傳送給我們的其中一個 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 控制台的「IAM 與管理」選單下方,您可以新增成員 (包括 Google 群組帳戶),做為專案擁有者。