Mulai

Dokumen ini memberikan semua informasi dasar yang Anda butuhkan untuk mulai menggunakan library. Panduan ini mencakup konsep library, menunjukkan contoh untuk berbagai kasus penggunaan, dan memberikan link ke informasi lebih lanjut.

Penyiapan

Ada beberapa langkah penyiapan yang perlu Anda selesaikan sebelum dapat menggunakan library ini:

1. Jika Anda belum memiliki Akun Google, daftar.
2. Jika Anda belum pernah membuat project Konsol API Google, baca halaman Mengelola Project dan buat project di Konsol API Google.
3. Instal paket NuGet yang ingin Anda gunakan.

Autentikasi dan otorisasi

Anda perlu memahami dasar-dasar penanganan autentikasi dan otorisasi API. Semua panggilan API harus menggunakan akses sederhana atau yang diotorisasi (dijelaskan di bawah). Banyak metode API memerlukan akses terotorisasi, tetapi beberapa metode dapat menggunakan salah satunya. Beberapa metode API yang dapat menggunakan perilaku yang berbeda, bergantung pada apakah Anda menggunakan akses sederhana atau yang diotorisasi. Lihat dokumentasi metode API untuk menentukan jenis akses yang sesuai.

1. Akses API sederhana (kunci API)

Panggilan API ini tidak mengakses data pengguna pribadi apa pun. Aplikasi Anda harus mengautentikasi dirinya sebagai aplikasi yang termasuk dalam project Konsol API Google Anda. Ini diperlukan untuk mengukur penggunaan proyek untuk tujuan akuntansi.

Kunci API: Untuk mengautentikasi aplikasi, gunakan kunci API untuk project Konsol API Anda. Setiap panggilan akses sederhana yang dilakukan aplikasi Anda harus menyertakan kunci ini.

Peringatan: Jaga kerahasiaan kunci API Anda. Jika seseorang mendapatkan kunci Anda, ia dapat menggunakannya untuk menghabiskan kuota Anda atau dikenai biaya atas project Konsol API Anda.

2. Akses API yang diizinkan (OAuth 2.0)

Panggilan API ini mengakses data pengguna pribadi. Sebelum Anda dapat memanggilnya, pengguna yang memiliki akses ke data pribadi harus memberikan akses aplikasi Anda. Oleh karena itu, aplikasi Anda harus diautentikasi, pengguna harus memberikan akses untuk aplikasi Anda, dan pengguna harus diautentikasi agar dapat memberikan akses tersebut. Semua ini dilakukan dengan OAuth 2.0 dan library yang ditulis untuknya.

Cakupan: Setiap API menetapkan satu atau beberapa cakupan yang mendeklarasikan sekumpulan operasi yang diizinkan. Contohnya, sebuah API mungkin memiliki cakupan hanya-baca dan baca-tulis. Saat aplikasi Anda meminta akses ke data pengguna, permintaan tersebut harus menyertakan satu atau beberapa cakupan. Pengguna harus menyetujui cakupan akses yang diminta aplikasi Anda.

Token refresh dan akses: Saat pengguna memberikan akses ke aplikasi Anda, server otorisasi OAuth 2.0 akan memberi aplikasi Anda token refresh dan akses. Token ini hanya valid untuk cakupan yang diminta. Aplikasi Anda menggunakan token akses untuk mengizinkan panggilan API. Masa berlaku token akses berakhir, tetapi token refresh tidak berlaku. Aplikasi Anda dapat menggunakan token refresh untuk memperoleh token akses baru.

Peringatan: Jaga kerahasiaan token akses dan refresh. Jika seseorang mendapatkan token Anda, ia dapat menggunakannya untuk mengakses data pribadi pengguna.

Client ID dan rahasia klien: String ini mengidentifikasi aplikasi Anda secara unik dan digunakan untuk memperoleh token. Item baris tersebut dibuat untuk project Anda di Konsol API. Ada tiga jenis client ID, jadi pastikan untuk mendapatkan jenis yang tepat untuk permohonan Anda:

• Client ID aplikasi web
• Client ID aplikasi yang diinstal
• Client ID Akun Layanan

Peringatan: Jaga kerahasiaan klien Anda. Jika seseorang mendapatkan rahasia klien Anda, mereka dapat menggunakannya untuk menghabiskan kuota Anda, mengenakan biaya atas project Konsol Anda, dan meminta akses ke data pengguna.

Contoh

Di bagian ini, ada contoh penggunaan API sederhana tanpa otorisasi. Untuk informasi selengkapnya tentang panggilan otorisasi, lihat halaman OAuth 2.0 untuk .NET.

Contoh API sederhana

Contoh ini menggunakan akses API sederhana untuk aplikasi command line. Library ini memanggil Google Discovery API untuk mencantumkan semua Google API.

Penyiapan misalnya

Mendapatkan kunci API Sederhana. Untuk menemukan kunci API aplikasi Anda, lakukan hal berikut:

1. Buka halaman Credentials di Konsol API.
2. API ini mendukung dua jenis kredensial. Buat kredensial yang sesuai untuk project Anda:

   • OAuth 2.0: Setiap kali aplikasi Anda meminta data pengguna pribadi, aplikasi harus mengirimkan token OAuth 2.0 beserta permintaannya. Aplikasi Anda terlebih dahulu mengirimkan client ID dan, mungkin, rahasia klien untuk mendapatkan token. Anda dapat membuat kredensial OAuth 2.0 untuk aplikasi web, akun layanan, atau aplikasi terinstal.

     Untuk informasi selengkapnya, lihat dokumentasi OAuth 2.0.

   • Kunci API: Permintaan yang tidak menyediakan token OAuth 2.0 harus mengirim kunci API. Kunci tersebut mengidentifikasi project Anda dan memberikan akses, kuota, serta laporan API.

     API ini mendukung beberapa jenis pembatasan pada kunci API. Jika kunci API yang Anda perlukan belum ada, buat kunci API di Konsol dengan mengklik Create credentials > API key. Anda dapat membatasi kunci ini sebelum menggunakannya dalam produksi dengan mengklik Restrict key dan memilih salah satu Restrictions.

Untuk menjaga keamanan kunci API Anda, ikuti praktik terbaik untuk menggunakan kunci API dengan aman.

Kode misalnya

using System;
using System.Threading.Tasks;

using Google.Apis.Discovery.v1;
using Google.Apis.Discovery.v1.Data;
using Google.Apis.Services;

namespace Discovery.ListAPIs
{
    /// <summary>
    /// This example uses the discovery API to list all APIs in the discovery repository.
    /// https://developers.google.com/discovery/v1/using.
    /// <summary>
    class Program
    {
        [STAThread]
        static void Main(string[] args)
        {
            Console.WriteLine("Discovery API Sample");
            Console.WriteLine("====================");
            try
            {
                new Program().Run().Wait();
            }
            catch (AggregateException ex)
            {
                foreach (var e in ex.InnerExceptions)
                {
                    Console.WriteLine("ERROR: " + e.Message);
                }
            }
            Console.WriteLine("Press any key to continue...");
            Console.ReadKey();
        }

        private async Task Run()
        {
            // Create the service.
            var service = new DiscoveryService(new BaseClientService.Initializer
                {
                    ApplicationName = "Discovery Sample",
                    ApiKey="[YOUR_API_KEY_HERE]",
                });

            // Run the request.
            Console.WriteLine("Executing a list request...");
            var result = await service.Apis.List().ExecuteAsync();

            // Display the results.
            if (result.Items != null)
            {
                foreach (DirectoryList.ItemsData api in result.Items)
                {
                    Console.WriteLine(api.Id + " - " + api.Title);
                }
            }
        }
    }
}

Tips untuk menggunakan kunci API:

• Untuk menggunakan layanan tertentu, Anda harus menambahkan referensi ke layanan tersebut. Misalnya, jika ingin menggunakan Tasks API, Anda harus menginstal paket NuGet Google.Apis.Tasks.v1.
• Untuk membuat instance layanan, cukup panggil konstruktornya. Contoh: new TasksService(new BaseClientService.Initializer {...});".
• Semua metode layanan berada pada resource individual pada objek layanan itu sendiri. Layanan Discovery memiliki resource Apis, yang berisi metode List. Saat Anda memanggil service.Apis.List(..), objek permintaan yang menargetkan metode ini akan ditampilkan.
  Untuk menjalankan permintaan, panggil metode Execute() atau ExecuteAsyc() pada permintaan.
• Tetapkan kunci API menggunakan properti ApiKey pada instance BaseClientService.Initializer.

Menemukan informasi tentang API

Halaman API yang Didukung mencantumkan semua API yang dapat diakses menggunakan library ini, serta link ke dokumentasi.

Anda juga dapat menggunakan APIs Explorer untuk menjelajahi API, mencantumkan metode yang tersedia, dan bahkan mencoba panggilan API dari browser.