非公开预览版入门

欢迎加入 Universal Ledger 非公开预览版！本指南将帮助您在 Google Cloud 项目中启用 API 并开始使用。

许可名单加入请求

由于这是非公开预览版发布，您需要与 Google 联系人完成一些初始的注册流程，才能获得 API 访问权限。完成后，您可以启用 API、分配 IAM 角色并开始发送请求。

  1. 确定您的客户 ID 或组织 ID

    在完成初始配置之前，贵组织需要先添加到 API 的内部许可名单中。您需要提供以下信息之一：

    • 贵组织的客户 ID，管理员可以按照查找客户 ID 的说明检索此 ID。此 ID 通常以“C”开头，后跟一系列字母数字字符。

    • 包含 Google Cloud 项目和资源的组织 ID。如需相关指导，请参阅获取组织资源 ID。此 ID 的格式为大型十进制数。

  2. 选择 Google Cloud 项目

    确定或创建您想要与 API 搭配使用的 Google Cloud 项目。如需了解详情，请参阅创建和管理项目。确保这些项目位于第 1 步中的同一客户组织内。

  3. 向 Google 联系人发送电子邮件

    发送电子邮件至 gcul-help@google.com，其中包含：

    • 第 (1) 步中的客户 ID 或组织 ID
    • 第 (2) 步中的项目 ID 列表

    您的组织和项目成功添加到非公开预览版许可名单后，他们会回复确认信息。完成此步骤后，您可以继续启用 API。

启用 API

将项目添加到许可名单后，您可以使用 gcloud 启用 Universal Ledger API，并使用特定的 IAM 角色为团队成员分配精细的访问权限。

  1. 使用 gcloud 启用 API

    如需启用该 API，请使用 gcloud services enable 命令：

    gcloud services enable universalledger.googleapis.com \
    --project=PROJECT_ID

    将 PROJECT_ID 替换为要启用相应 API 的项目的 ID。

    如果您是项目所有者，现在应该可以向 API 发送请求了。

  2. 使用 IAM 角色设置精细的访问权限

    如需为组织的其他成员精细管理对 Universal Ledger API 的访问权限，您可以向他们分配 IAM 角色。该 API 配置了三个 IAM 角色，每个角色提供不同的访问权限层级：

    • roles/universalledger.viewer：对可用端点和网络的只读访问权限。授予查看端点以及使用端点查询网络的权限。
    • roles/universalledger.editor：对可用端点和网络的完全访问权限。授予查询网络和提交交易的权限。
    • roles/universalledger.admin：对可用端点和网络的完全访问权限。授予查询网络和提交交易的权限。此角色与 Universal Ledger Editor 角色具有相同的权限，但未来可能会发生变化。

    如需向用户添加新的 IAM 角色，请使用 gcloud projects add-iam-policy-binding 命令：

    gcloud projects add-iam-policy-binding PROJECT_ID \
    --member="PRINCIPAL" \
    --role="ROLE"

    替换以下内容：

    • PROJECT_ID：要添加 IAM 政策绑定的项目
    • PRINCIPAL：要向其添加角色的主账号，例如：user:test-user@gmail.com 或 serviceAccount:test123@example.domain.com。
    • ROLE：要分配给主账号的之前所述的角色之一

发送第一个请求

现在，您可以开始使用该 API 了！

如需验证之前的配置是否正常运行，请先使用 gcloud auth login 命令进行身份验证：

gcloud auth login

然后尝试发送endpoints.list 请求：

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -X GET "https://universalledger.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/endpoints"

对给定通用账本网络的请求通过 API 端点发送，这些端点将采用以下形式

https://universalledger.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/endpoints/NETWORK_NAME

如需详细了解可用的方法，请参阅 REST 或 RPC API 参考文档。

可用的影音平台和区域

在非公开预览期间，将提供两个网络：

  • gcul-pilot-testing：频繁更新，包含实验性功能。使用此网络可快速迭代并测试新的素材资源类型和产品。
  • gcul-user-testing：更新频率较低的网络，旨在集成到付款和结算工作流中，同时处理测试交易和实际交易。

下表总结了每个网络可使用验证器的区域。

区域 gcul-pilot-testing gcul-user-testing
us-central1
us-east1
us-east4
us-east5
us-west1
europe-west2
europe-west3

后续步骤