Panduan Developer: JavaScript

Blogger Data API memungkinkan aplikasi klien melihat dan memperbarui konten Blogger dalam bentuk feed Google Data API.

Aplikasi klien Anda dapat menggunakan Blogger Data API untuk membuat postingan blog baru, mengedit atau menghapus postingan blog yang ada, dan membuat kueri untuk postingan blog yang cocok dengan kriteria tertentu.

Selain memberikan beberapa latar belakang tentang kemampuan Blogger Data API, dokumen ini memberikan contoh interaksi Data API dasar menggunakan library klien JavaScript. Jika Anda tertarik untuk lebih memahami protokol dasar yang digunakan library, lihat bagian Protokol dalam panduan developer ini.

Daftar Isi

  1. Penonton
  2. Persyaratan penggunaan
  3. Tentang lingkungan yang didukung
  4. Memulai
    1. Membuat akun Blogger
    2. Mendapatkan library
  5. Mengautentikasi ke layanan Blogger
    1. Autentikasi proxy AuthSub

Audiens

Dokumen ini ditujukan untuk programmer yang ingin menulis aplikasi klien JavaScript yang dapat berinteraksi dengan Blogger. Panduan ini memberikan serangkaian contoh interaksi Data API dasar menggunakan library klien JavaScript.

Untuk informasi referensi Blogger Data API, lihat Panduan referensi protokol. Dokumen ini menganggap bahwa Anda memahami ide umum di balik protokol Google Data API serta model data dan alur kontrol yang digunakan oleh library klien JavaScript. Anda juga dianggap telah memahami cara memprogram dalam JavaScript.

Untuk informasi referensi tentang class dan metode yang disediakan oleh library klien, lihat referensi API library klien JavaScript.

Dokumen ini dirancang untuk dibaca secara berurutan; setiap contoh dibuat berdasarkan contoh sebelumnya.

Persyaratan penggunaan

Anda setuju untuk mematuhi Persyaratan Penggunaan Library Klien JavaScript Google saat menggunakan library klien JavaScript.

Tentang lingkungan yang didukung

Saat ini, kami hanya mendukung aplikasi klien JavaScript yang berjalan di halaman web di browser. Browser yang saat ini didukung adalah Firefox 1.5 dan yang lebih baru, serta Internet Explorer 6.0 dan yang lebih baru.

Library klien JavaScript menangani semua komunikasi dengan server layanan. Jika Anda adalah developer JS berpengalaman, Anda mungkin berpikir, "Tapi bagaimana dengan kebijakan origin yang sama?" Library klien JavaScript memungkinkan klien Anda mengirim permintaan Google Data API dari domain mana pun sekaligus tetap mematuhi model keamanan browser.

Memulai

Sebelum dapat menulis aplikasi klien JavaScript, Anda perlu melakukan beberapa penyiapan untuk mendapatkan library.

Membuat akun Blogger

Sebaiknya daftar ke akun Blogger untuk tujuan pengujian. Blogger menggunakan Akun Google, jadi jika Anda sudah memiliki Akun Google, Anda sudah siap.

Mendapatkan library

Sebelum klien dapat menggunakan library klien, klien harus meminta kode library klien dari server.

Mulailah dengan menggunakan tag <script> di bagian <head> dokumen HTML Anda untuk mengambil loader Google AJAX API:

<script type="text/javascript" src="https://www.google.com/jsapi"></script>

Untuk mendapatkan library klien Google Data API setelah mengambil loader, gunakan baris berikut dalam kode penyiapan JavaScript, yang harus dipanggil dari bagian <head> dokumen HTML Anda (atau dari file JavaScript yang disertakan menggunakan tag <script> di bagian <head> dokumen HTML Anda):

google.load("gdata", "1.x");

Parameter kedua untuk google.load() adalah nomor versi library klien JavaScript yang diminta.  Skema penomoran versi kami dimodelkan setelah yang digunakan oleh Google Maps API. Berikut adalah kemungkinan angka versi dan artinya:

"1"
Revisi kedua dari terakhir untuk versi utama 1.
"1.x"
Revisi terbaru dari versi utama 1.
"1.s"
Revisi stabil terbaru dari versi utama 1. Kami terkadang akan mendeklarasikan versi library klien tertentu sebagai "stabil", berdasarkan masukan yang kami terima dari developer. Namun, versi tersebut mungkin tidak memiliki fitur terbaru.
"1.0", "1.1", dll.
Versi tertentu dari library, dengan nomor revisi utama dan minor yang ditentukan.

Setelah memanggil google.load(), Anda harus memberi tahu loader untuk menunggu hingga halaman selesai dimuat, lalu memanggil kode Anda:

google.setOnLoadCallback(getMyBlogFeed);

Dengan getMyBlogFeed() adalah fungsi yang akan kita tentukan di bagian berikutnya dalam dokumen ini. Gunakan pendekatan ini, bukan memiliki pengendali onload yang dilampirkan ke elemen <body>.

Mengautentikasi ke layanan Blogger

Anda dapat mengakses feed publik dan pribadi menggunakan Blogger Data API. Feed publik tidak memerlukan autentikasi apa pun, tetapi bersifat hanya baca. Jika Anda ingin mengubah blog, klien Anda harus melakukan autentikasi sebelum meminta feed pribadi.

Library klien JavaScript menggunakan sistem autentikasi AuthSub. Untuk informasi selengkapnya tentang autentikasi dengan Google Data API secara umum, lihat dokumentasi autentikasi.

Autentikasi proxy AuthSub

Autentikasi proxy AuthSub digunakan oleh aplikasi web yang perlu mengautentikasi penggunanya ke Akun Google. Operator situs dan kode klien tidak memiliki akses ke nama pengguna dan sandi untuk pengguna Blogger; sebagai gantinya, klien mendapatkan token AuthSub khusus yang memungkinkan klien bertindak atas nama pengguna tertentu.

Berikut adalah ringkasan singkat tentang apa yang terjadi selama proses autentikasi untuk klien JavaScript berbasis web:

  1. Aplikasi klien memanggil metode google.accounts.user.login() yang disediakan oleh library klien, dengan meneruskan nilai "cakupan" yang menunjukkan layanan Google yang akan digunakan. Untuk Blogger, cakupannya adalah "http://www.blogger.com/feeds/".
  2. Library klien mengirim browser ke halaman "Permintaan Akses" Google, tempat pengguna dapat memasukkan kredensial untuk login ke layanan.
  3. Jika pengguna berhasil login, sistem AuthSub akan mengirim browser kembali ke URL klien web, dengan meneruskan token autentikasi.
  4. Library klien JavaScript menyimpan token dalam cookie dan menampilkan kontrol ke fungsi aplikasi klien yang memanggil google.accounts.user.login().
  5. Saat aplikasi klien kemudian memanggil metode library klien yang berinteraksi dengan Blogger, library klien akan otomatis melampirkan token ke semua permintaan.

Catatan: Agar library klien JavaScript dapat membuat permintaan Blogger yang diautentikasi di browser web, halaman Anda harus berisi gambar yang dihosting di domain yang sama dengan halaman Anda. Gambar dapat berupa gambar apa pun, bahkan gambar transparan satu piksel, tetapi harus ada gambar di halaman. Jika tidak ingin gambar muncul di halaman, Anda dapat menggunakan atribut style tag <img> untuk memosisikan gambar di luar area rendering. Contoh: style="position:absolute; top: -1000px;"

Berikut adalah kode aplikasi klien yang menangani login. Kita akan memanggil fungsi setupMyService() dari kode lain nanti.

function logMeIn() {
  scope = "http://www.blogger.com/feeds/";
  var token = google.accounts.user.login(scope);
}

function setupMyService() {
  var myService =
    new google.gdata.blogger.BloggerService('exampleCo-exampleApp-1');
  logMeIn();
  return myService;
}

Tips: Sebaiknya berikan tombol login atau mekanisme input pengguna lainnya untuk meminta pengguna memulai proses login secara manual. Jika Anda memanggil google.accounts.user.login() segera setelah pemuatan, tanpa menunggu interaksi pengguna, hal pertama yang dilihat pengguna saat tiba di halaman Anda adalah halaman login Google. Jika pengguna memutuskan untuk tidak login, Google tidak akan mengarahkan mereka kembali ke halaman Anda; jadi dari sudut pandang pengguna, mereka mencoba mengunjungi halaman Anda, tetapi diarahkan keluar dan tidak pernah diarahkan kembali. Skenario ini dapat membingungkan dan membuat pengguna frustrasi. Dalam kode contoh dalam dokumen ini, kita akan memanggil google.accounts.user.login() segera setelah memuat, agar contoh tetap sederhana, tetapi kami tidak merekomendasikan pendekatan ini untuk aplikasi klien di dunia nyata.

Perhatikan bahwa Anda tidak perlu melakukan apa pun dengan variabel bernama token; library klien melacak token, sehingga Anda tidak perlu melakukannya.

Catatan: Saat Anda membuat objek BloggerService baru, library klien akan memanggil metode bernama google.gdata.client.init(), yang memeriksa apakah browser tempat klien berjalan didukung. Jika ada error, library klien akan menampilkan pesan error kepada pengguna. Jika ingin menangani error semacam ini sendiri, Anda dapat memanggil google.gdata.client.init(handleInitError) secara eksplisit sebelum membuat layanan, dengan handleInitError() sebagai fungsi Anda. Jika error init terjadi, fungsi Anda akan menerima objek Error standar; Anda dapat melakukan apa pun yang Anda inginkan dengan objek tersebut.

Token akan tetap valid hingga Anda mencabutnya dengan memanggil google.accounts.user.logout():

function logMeOut() {
  google.accounts.user.logout();
}

Jika Anda tidak memanggil logout(), cookie yang menyimpan token akan berlaku selama dua tahun, kecuali jika pengguna menghapusnya. Cookie dipertahankan di seluruh sesi browser, sehingga pengguna dapat menutup browser, lalu membukanya kembali dan kembali ke klien Anda, dan mereka akan tetap login.

Namun, ada situasi tertentu yang tidak biasa saat token dapat menjadi tidak valid selama sesi. Jika Blogger menolak token, klien Anda harus menangani kondisi error dengan memanggil logout() untuk menghapus cookie yang berisi token saat ini, lalu memanggil login() lagi untuk mendapatkan token baru yang valid.

Ada dua metode AuthSub lain yang mungkin berguna bagi Anda dalam berbagai konteks:

  • google.accounts.user.checkLogin(scope) memberi tahu Anda apakah browser saat ini memiliki token autentikasi untuk cakupan yang diberikan atau tidak.
  • google.accounts.user.getInfo() memberikan informasi mendetail tentang token saat ini, untuk penggunaan proses debug.

Untuk mengetahui detail tentang penggunaan JavaScript untuk berinteraksi dengan AuthSub, termasuk informasi tentang pengelolaan token dan checkLogin() serta getInfo(), lihat dokumen Menggunakan Autentikasi "AuthSub" dengan Library Klien JavaScript.

Kembali ke atas