Memulai

Halaman ini menjelaskan cara developer dapat mulai menggunakan Cloud de Confiance by S3NS API.

Jika Anda menggunakan Cloud de Confiance API untuk pertama kalinya, Anda dapat mengikuti langkah-langkah dalam panduan ini untuk memanggil API menggunakan perintah curl. Anda dapat menggunakan perintah curl untuk bereksperimen dengan API sebelum mengembangkan aplikasi.

Membuat S3NS project

Untuk menggunakan Cloud de Confiance API, Anda harus memiliki akun pengguna (akun S3NS atau akun dari penyedia identitas eksternal) dan projectS3NS . Project setara dengan akun developer. Objek ini berfungsi sebagai penampung resource untuk resource Cloud de Confiance Anda. Project ini juga menyediakan batas isolasi untuk penggunaan layanan Cloud de Confiance by S3NS , sehingga Anda dapat mengelola batas kuota dan penagihan secara independen di tingkat project. Telemetri dan dasbor penggunaan juga dikelompokkan berdasarkan project. Jika Anda belum memiliki project, Anda dapat membuatnya menggunakan Cloud de Confiance console.

Project dapat memiliki berbagai resource, termasuk kunci API, klien OAuth, akun layanan, VM Compute Engine, bucket Cloud Storage, dan set data BigQuery. Saat aplikasi memanggil API Cloud de Confiance , project yang memiliki kredensial aplikasi disebut project klien, dan project yang memiliki resource target disebut project resource. Jika permintaan API menyentuh beberapa resource, beberapa project resource akan terlibat.

Jika Anda ingin berhenti menggunakan Cloud de Confiance karena alasan apa pun, Anda dapat menggunakan konsolCloud de Confiance untuk menghapus project Anda. Project Anda dan semua resource dalam project akan dihapus setelah periode retensi. Perhatikan bahwa berbagai jenis data memiliki periode retensi yang berbeda.

Menemukan API

Sebelum menggunakan API Cloud de Confiance apa pun, Anda harus menggunakan Cloud de Confiance konsol API Library untuk menjelajahi API Cloud de Confiance yang tersedia dan menemukan API yang paling sesuai dengan kebutuhan bisnis Anda.

Mengaktifkan API

Beberapa Cloud de Confiance API diaktifkan secara default. Untuk menggunakan Cloud de Confiance API yang tidak diaktifkan secara default, Anda harus mengaktifkannya untuk project Anda. Bergantung pada layanan dan project yang terlibat dari aplikasi Anda, termasuk project klien dan project resource, Anda mungkin perlu mengaktifkan API untuk beberapa project. Saat Anda mengaktifkan API yang bergantung pada API lain, API tersebut juga diaktifkan secara bersamaan.

Untuk mengaktifkan API, Anda harus menyetujui Persyaratan Layanan dan tanggung jawab penagihan untuk API tersebut. Anda memerlukan izin serviceusage.services.enable di project untuk mengaktifkan API. Untuk mengetahui informasi selengkapnya, lihat Kontrol Akses Penggunaan Layanan.

Untuk mengaktifkan API untuk project menggunakan konsol:

  1. Buka Cloud de Confiance API Library konsol.
  2. Dari daftar project, pilih project yang ingin Anda gunakan.
  3. Di Library API, pilih API yang ingin Anda aktifkan. Jika Anda memerlukan bantuan menemukan API, gunakan kolom penelusuran dan filter.
  4. Di halaman API, klik ENABLE.

Dari halaman yang sama, Anda dapat menonaktifkan API untuk project jika tidak lagi menggunakannya untuk menghindari penyalahgunaan dan tagihan yang tidak disengaja. Anda juga dapat mengaktifkan dan menonaktifkan Cloud API menggunakan gcloud CLI dan Service Usage API:

gcloud services enable pubsub.googleapis.com
gcloud services disable pubsub.googleapis.com

Mengaktifkan penagihan

Beberapa Cloud API mengenakan biaya untuk penggunaan. Anda harus mengaktifkan penagihan untuk project sebelum dapat mulai menggunakan API ini di project Anda. Penggunaan API dalam project ditagih ke akun penagihan yang terkait dengan project tersebut.

Melakukan autentikasi ke API

Cara Anda melakukan autentikasi ke API bergantung pada lingkungan pengembangan Anda dan metode autentikasi yang didukung API.

Menyiapkan Kredensial Default Aplikasi untuk digunakan di berbagai lingkungan adalah pendekatan yang paling umum, dan direkomendasikan untuk sebagian besar aplikasi. Jika API mendukung kunci API, itu adalah opsi lain. Jika aplikasi Anda perlu mengakses resource Cloud yang dimiliki oleh pengguna akhir Anda, Anda harus membuat ID Klien OAuth 2.0 dan menggunakan library autentikasi.

Untuk informasi umum tentang autentikasi, lihat Autentikasi di Google.

Membangun aplikasi

Jika Anda membangun aplikasi menggunakan Cloud API, sebaiknya gunakan Cloud de Confiance library klien jika tersedia. Library klien dapat menangani fitur API umum untuk kenyamanan Anda, seperti autentikasi, penanganan error, percobaan ulang, dan validasi payload. Anda harus meneruskan kredensial aplikasi ke library klien selama inisialisasi, sehingga library klien dapat melakukan panggilan keCloud de Confiance API atas nama aplikasi Anda.

Informasi selengkapnya