このガイドでは、Universal Ledger プレビュー API を有効にして、 Google Cloud プロジェクトで使い始める方法について説明します。
許可リスト登録リクエスト
このプロダクトはプレビュー版であるため、API にアクセスするには、最初の手順としてオンボーディングを行う必要があります。 完了すると、API を有効にして IAM ロールを割り当て、リクエストの送信を開始できます。
お客様 ID または組織 ID を確認する
オンボーディングを行う前に、組織を API の内部許可リストに追加する必要があります。次のいずれかが必要です。
組織のお客様 ID 。 お客様 ID を確認するの手順に沿って 管理者が取得できます。通常、この ID は「C」で始まり、その後に英数字が続きます。
Google Cloud プロジェクトと リソースを保持する組織 ID。詳しくは、 組織リソース ID の取得をご覧ください。 この ID は大きな 10 進数で表示されます。
プロジェクト Google Cloud を選択する
API で使用する Google Cloud プロジェクトを特定または作成します。詳しくは、プロジェクトの作成と管理 をご覧ください。これらのプロジェクトが、ステップ 1 で確認した同じお客様組織内に存在することを確認してください。
お問い合わせ
次の情報を含めて gcul-help@google.com にメールを送信します。
- ステップ 1 で確認したお客様 ID または組織 ID
- ステップ 2 で確認したプロジェクト ID のリスト
組織とプロジェクトがプレビュー許可リストに正常に追加されると、確認メールが届きます。このステップが完了したら、API を有効にできます。
API の有効化
プロジェクトが許可リストに追加されたら、gcloud を使用して Universal Ledger API を有効にし、特定の IAM ロールを使用してチームメンバーにきめ細かいアクセス権を割り当てることができます。
gcloud を使用して API を有効にする
API を有効にするには、
gcloud services enableコマンドを使用します。gcloud services enable universalledger.googleapis.com \ --project=PROJECT_IDPROJECT_IDは、API を有効にするプロジェクトの ID に置き換えます。プロジェクト オーナーであれば、API にリクエストを送信できるようになります。
IAM ロールを使用してきめ細かいアクセス権を設定する
組織の他のメンバーに対して Universal Ledger API へのきめ細かいアクセス権を管理するには、IAM ロールを割り当てます。API には 3 つの 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 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"
特定の Universal Ledger ネットワークへのリクエストは、API エンドポイントを使用して送信されます。形式は次のようになります。
https://universalledger.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/endpoints/NETWORK_NAME
これらの手順を完了すると、Universal Ledger API へのアクセスが検証されます。ただし、ネットワークにトランザクションを送信するには、まず Universal Ledger アカウントを作成する必要があります。次のステップについては、次のステップをご覧ください。
利用可能なネットワークとリージョン
プレビュー期間中は、次の 2 つのネットワークを利用できます。
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 |
次のステップ
- 台帳での アカウントの作成をリクエストする。
- Python で RPC リクエストを 送信する方法を学習する。
- Universal Ledger API プロトコル バッファ定義を確認する。