集成指南

获取私钥

使用新手入门界面

如需与 API 集成，您必须创建一个 Google Cloud 项目。之后，创建服务帐号并获取私钥。首先，请点击以下按钮：

创建服务帐号

手动生成密钥

如果上面的界面失败，请尝试以下操作：

  1. 转到 Google Cloud Console。
  2. 选择将使用该 API 访问的项目。
  3. 在左侧的“IAM”管理菜单下，找到服务帐号并创建新的服务帐号，该帐号将成为项目的所有者。
  4. 创建服务帐号后，您应该会收到一个私钥。

将服务帐号列入白名单

创建服务帐号后：

  1. 请通过 mdp-support@google.com 与 GTAF 团队联系，该帐号是该项目的所有者。我们会将该 Google 帐号列入白名单，使其能够访问 Mobile Data Plan Sharing API 端点。
  2. 将服务帐号与 Google ISP 门户上的运营商相关联。运营商可以通过转到 API 访问权限来建立这种关联。

启用库

列入白名单操作完成后：

  1. 访问Google云端控制台。
  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. 发出测试调用，如下所示。我们在集成过程中配置 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 群组帐号）作为项目的所有者。