預覽新手上路流程

本指南說明如何啟用 Universal Ledger 預先發布版 API，並在專案中開始使用。 Google Cloud

許可清單要求

由於產品處於預覽階段，您需要完成一些新手上路步驟，才能存取 API。完成後，您就能啟用 API、指派 IAM 角色，並開始傳送要求。

  1. 找出客戶或機構 ID

    開始使用前，貴機構必須先加入 API 的內部允許清單。請提供下列任一項文件：

    • 貴機構的客戶 ID。管理員可以按照「找出客戶 ID」一文的操作說明，取得這項資訊。這個 ID 通常以「C」開頭，後面接著一連串英數字元。

    • 保存 Google Cloud 專案和資源的機構 ID。如需相關指引，請參閱「取得機構資源 ID」。這個 ID 的格式為大型十進位數字。

  2. 選取 Google Cloud 專案

    找出或建立要搭配 API 使用的 Google Cloud 專案。詳情請參閱「建立及管理專案」。確認這些專案位於步驟 (1) 中的相同客戶機構。

  3. 與我們聯絡

    傳送電子郵件至 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 編輯者角色具備相同的權限，但日後可能會有所變動。

    如要為使用者新增 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 application-default login 指令進行驗證：

gcloud auth application-default login

然後嘗試傳送endpoints.list要求：

curl -H "Authorization: Bearer $(gcloud auth application-default 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

完成這些步驟後，您對 Universal Ledger API 的存取權就會通過驗證。不過，如要將交易提交至網路，您必須先建立 Universal Ledger 帳戶。如需後續步驟的指標，請參閱「後續步驟」。

適用網路和地區

預先發布版提供以下兩個網路：

  • 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

後續步驟