Panduan ini akan membantu Anda mengaktifkan Universal Ledger Preview API dan mulai menggunakan project Anda Google Cloud .
Permintaan daftar yang diizinkan
Karena produk masih dalam Pratinjau, beberapa langkah orientasi awal diperlukan untuk mendapatkan akses ke API. Setelah selesai, Anda dapat mengaktifkan API, menetapkan peran IAM, dan mulai mengirim permintaan.
Menentukan ID pelanggan atau organisasi Anda
Sebelum melakukan aktivasi, organisasi Anda harus ditambahkan ke daftar yang diizinkan internal untuk API. Anda harus memberikan salah satu dari:
ID pelanggan organisasi Anda, yang dapat diambil oleh administrator dengan mengikuti petunjuk untuk Menemukan ID pelanggan Anda. ID ini biasanya dimulai dengan "C" yang diikuti dengan serangkaian karakter alfanumerik.
ID organisasi yang menyimpan Google Cloud project dan resource Anda. Untuk mendapatkan panduan, lihat Mendapatkan ID resource organisasi Anda. ID ini diformat sebagai bilangan desimal besar.
Pilih Google Cloud project
Identifikasi atau buat project Google Cloud yang ingin Anda gunakan dengan API. Untuk mempelajari lebih lanjut, lihat Membuat dan mengelola project. Pastikan bahwa project ini ada dalam organisasi pelanggan yang sama dari langkah (1).
Hubungi kami
Kirim email ke gcul-help@google.com yang berisi:
- ID Pelanggan atau ID Organisasi Anda dari langkah (1)
- Daftar Project ID dari langkah (2)
Anda akan menerima email konfirmasi setelah organisasi dan project Anda berhasil ditambahkan ke daftar yang diizinkan untuk pratinjau. Setelah langkah ini selesai, Anda dapat melanjutkan untuk mengaktifkan API.
Mengaktifkan API
Setelah project Anda ditambahkan ke daftar yang diizinkan, Anda dapat mengaktifkan
Universal Ledger API menggunakan gcloud, dan menetapkan akses terperinci kepada anggota tim Anda
menggunakan peran IAM tertentu.
Mengaktifkan API menggunakan gcloud
Untuk mengaktifkan API, gunakan perintah
gcloud services enable:gcloud services enable universalledger.googleapis.com \ --project=PROJECT_IDGanti
PROJECT_IDdengan ID project tempat Anda ingin mengaktifkan API.Jika Anda adalah pemilik project, Anda kini dapat mengirim permintaan ke API.
Menyiapkan akses terperinci menggunakan peran IAM
Untuk mengelola akses terperinci ke Universal Ledger API bagi anggota lain di organisasi Anda, Anda dapat menetapkan peran IAM kepada mereka. API memiliki tiga peran IAM yang dikonfigurasi, yang masing-masing menyediakan lapisan akses yang berbeda:
roles/universalledger.viewer: Akses hanya baca ke endpoint dan jaringan yang tersedia. Memberikan kemampuan untuk melihat endpoint, dan mengkueri jaringan menggunakan endpoint.roles/universalledger.editor: Akses penuh ke endpoint dan jaringan yang tersedia. Memberikan akses untuk membuat kueri jaringan dan mengirimkan transaksi.roles/universalledger.admin: Akses penuh ke endpoint dan jaringan yang tersedia. Memberikan akses untuk mengkueri jaringan dan mengirimkan transaksi. Peran ini memiliki izin yang sama dengan peran Editor Universal Ledger, yang dapat berubah di masa mendatang.
Untuk menambahkan peran IAM baru kepada pengguna, gunakan perintah
gcloud projects add-iam-policy-binding:gcloud projects add-iam-policy-binding PROJECT_ID \ --member="PRINCIPAL" \ --role="ROLE"Ganti kode berikut:
PROJECT_ID: project tempat binding kebijakan IAM akan ditambahkanPRINCIPAL: akun utama yang ditambahkan perannya, misalnya:user:test-user@gmail.comatauserviceAccount:test123@example.domain.com.ROLE: salah satu peran yang dijelaskan sebelumnya untuk ditetapkan ke akun utama
Mengirim permintaan pertama Anda
Sekarang Anda dapat mulai menggunakan API.
Untuk memvalidasi bahwa konfigurasi sebelumnya berfungsi dengan benar, lakukan autentikasi terlebih dahulu menggunakan perintah gcloud auth application-default login:
gcloud auth application-default login
Kemudian, coba kirim endpoints.list
permintaan:
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"
Permintaan ke jaringan Universal Ledger tertentu dikirim menggunakan endpoint API, yang akan memiliki bentuk
https://universalledger.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/endpoints/NETWORK_NAME
Dengan menyelesaikan langkah-langkah ini, akses Anda ke Universal Ledger API akan divalidasi. Namun, untuk mengirimkan transaksi ke jaringan, Anda harus membuat akun Universal Ledger terlebih dahulu. Lihat Langkah berikutnya untuk mendapatkan petunjuk tentang langkah-langkah selanjutnya.
Jaringan dan wilayah yang tersedia
Ada dua jaringan yang tersedia selama pratinjau:
gcul-pilot-testing: Menerima update sering dengan fitur eksperimental. Jaringan ini adalah jaringan yang paling umum digunakan untuk iterasi cepat dan menguji jenis aset dan produk baru.gcul-user-testing: Jaringan yang lebih jarang diperbarui, yang ditujukan untuk diintegrasikan ke dalam alur kerja pembayaran dan penyelesaian, yang menangani transaksi uji dan live. Hanya tersedia berdasarkan permintaan untuk kasus penggunaan terbatas.
Tabel berikut merangkum region tempat validator tersedia untuk setiap jaringan ini.
| Wilayah | gcul-pilot-testing | gcul-user-testing |
|---|---|---|
| us-central1 | ||
| us-east1 | ||
| us-east4 | ||
| us-east5 | ||
| us-west1 | ||
| europe-west2 | ||
| europe-west3 |
Langkah berikutnya
- Minta pembuatan akun di buku besar.
- Pelajari cara mengirim permintaan RPC dengan Python.
- Pelajari definisi buffer protokol Universal Ledger API.