集成指南

获取私钥

使用初始配置界面

如需与该 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云端控制台。
  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 群组账号）作为项目的所有者。