Blogger JSON API: Memulai

Dokumen ini menjelaskan cara mulai menggunakan Blogger JSON API.

Daftar Isi

  1. Pengantar
  2. Sebelum memulai
    1. Buat Akun Google
    2. Mengenal Blogger
    3. Pelajari cara mengizinkan permintaan dan mengidentifikasi aplikasi
  3. Latar belakang Blogger JSON API
    1. Konsep Blogger
    2. Model data Blogger JSON API
    3. Operasi Blogger JSON API
  4. Gaya panggilan
    1. REST
  5. Format data
    1. JSON

Pengantar

Dokumen ini ditujukan untuk developer yang ingin menulis aplikasi yang dapat berinteraksi dengan Blogger JSON API.

Blogger JSON API memperluas Blogger Data API versi 2.0. Jika Anda ingin mengambil data dari Blogger dalam format JSON, bukan XML, gunakan Blogger JSON API. Jika Anda ingin mengambil data dalam format XML, gunakan Blogger Data API.

Versi API Blogger Blogger saat ini bersifat hanya-baca; namun, kami berencana untuk menambahkan kemampuan baca/tulis, dan kemampuan lainnya. Jangan ragu untuk meminta fitur lainnya di Forum Bantuan Blogger.

Sebelum memulai

Dapatkan Akun Google

Pastikan Anda telah menyiapkan Akun Google. Sebaiknya gunakan Akun Google terpisah untuk tujuan pengembangan dan pengujian guna melindungi diri Anda dari kehilangan data yang tidak disengaja. Jika sudah memiliki akun pengujian, berarti Anda sudah siap; Anda dapat mengunjungi antarmuka pengguna Blogger untuk menyiapkan, mengedit, atau melihat data pengujian.

Memahami Blogger

Jika Anda belum memahami konsep Blogger, baca dokumen ini dan lakukan eksperimen dengan antarmuka pengguna sebelum mulai membuat kode. Dokumen ini mengasumsikan bahwa Anda sudah terbiasa dengan Blogger dan konsep pemrograman web, serta format data web.

Pelajari cara mengizinkan permintaan dan mengidentifikasi aplikasi Anda

Saat aplikasi Anda meminta data pribadi, permintaan tersebut harus diberi otorisasi oleh pengguna terautentikasi yang memiliki akses ke data tersebut.

Saat aplikasi Anda meminta data publik, permintaan tersebut tidak perlu diotorisasi, tetapi harus disertai dengan ID, seperti kunci API.

Untuk mendapatkan informasi tentang cara mengizinkan permintaan dan menggunakan kunci API, lihat Memberi otorisasi permintaan dan mengidentifikasi aplikasi dalam dokumen Menggunakan dokumen API.

Latar belakang Blogger JSON API

Konsep Blogger

Blogger dibuat berdasarkan lima konsep dasar:

  • Blog: Konsep root API. Blog memiliki postingan dan halaman. Ini adalah penampung untuk informasi meta blog seperti Nama dan Blog.
  • Postingan: Postingan blog adalah item yang dapat dipublikasikan yang telah dibuat oleh penulis blog. Informasi ini dimaksudkan untuk tepat waktu, yang mencerminkan apa yang ingin dipublikasikan penulis kepada dunia. Hal ini dipahami bahwa seiring berjalannya waktu, blog akan memposting usia konten dan menjadi kurang relevan.
  • Komentar: Komentar adalah tempat orang selain penulis postingan blog bereaksi terhadap apa yang telah ditulis penulis. Mulai dari batu bata hingga buket.
  • Halaman: Halaman adalah tempat untuk konten statis, seperti informasi biografi, atau cara untuk menghubungi pengguna. Biasanya ini adalah informasi sepanjang masa yang tidak sering berubah.
  • Pengguna: Pengguna adalah seseorang yang berinteraksi dengan Blogger, baik sebagai Penulis, Administrator, maupun hanya Pembaca. Untuk blog publik, pembaca mungkin anonim, tetapi pada blog pribadi, pembaca harus diidentifikasi oleh Blogger.

Model data Blogger JSON API

Resource adalah entity data individual dengan ID unik. Blogger JSON API berfungsi pada lima jenis resource:

  • Blog Blogs: Mewakili blog.
  • Resource Postingan: Merepresentasikan postingan; setiap Resource Postingan adalah turunan Resource Blog.
  • Resource Komentar: Merepresentasikan komentar di postingan tertentu; setiap Resource Komentar adalah turunan dari Resource Postingan.
  • Resource Halaman: Mewakili halaman statis; setiap Resource Halaman adalah turunan dari Resource Blog.
  • Resource Pengguna: Mewakili pengguna non-anonim. Ini digunakan untuk mengidentifikasi Penulis Halaman, Postingan, atau Komentar.
Blog Resource memiliki dua jenis resource turunan, Halaman dan Postingan. Resource Postingan mungkin memiliki turunan Resource Komentar.
Ringkasan hubungan antar-resource

Model data Blogger JSON API didasarkan pada grup resource, yang disebut koleksi:

Koleksi Blog
<span="apicollection">Blogs Collection terdiri dari semua Blog yang dapat diakses pengguna. Anda dapat mencantumkan Blogs menurut pengguna, atau mengambil satu Blog berdasarkan ID.</span="apicollection">
Koleksi Postingan
Koleksi Postingan terdiri dari semua Resource Postingan dalam Resource Blog tertentu.
Pengumpulan Komentar
Koleksi Komentar terdiri dari semua Resource Komentar dalam Resource Postingan tertentu.
Pengumpulan Halaman
Koleksi Halaman terdiri dari semua Resource Halaman dalam Resource Blog tertentu.
Pengumpulan Pengguna
Koleksi Pengguna terdiri dari semua Resource Pengguna di Blogger, sehingga tidak dapat dicantumkan. Pengguna dapat mengambil Resource Pengguna mereka sendiri (tetapi tidak dengan orang lain) menurut ID, atau dengan menggunakan ID self.

Operasi Blogger JSON API

Anda dapat memanggil dua metode yang berbeda pada koleksi dan resource di Blogger JSON API, seperti yang dijelaskan dalam tabel berikut.

Operasi Deskripsi Pemetaan HTTP REST
list Mencantumkan semua fasilitas dalam koleksi. GET di URI koleksi.
dapatkan Mendapatkan resource tertentu. GET pada URI resource.

Tabel di bawah menunjukkan metode mana yang didukung oleh setiap jenis resource. Semua operasi daftar dan get di blog pribadi memerlukan autentikasi.

Jenis Resource
Metode yang Didukung
daftar dapatkan
Blog ya ya
Postingan ya ya
Komentar ya ya
Halaman ya ya
Pengguna tidak ya

Gaya panggilan

Ada beberapa cara untuk memanggil API:

REST

REST adalah gaya arsitektur software yang memberikan pendekatan praktis dan konsisten untuk meminta serta mengubah data.

Istilah REST adalah singkatan dari "Representational State Transfer." Dalam konteks Google API, merujuk pada penggunaan kata kerja HTTP untuk mengambil dan memodifikasi representasi data yang disimpan oleh Google.

Dalam sistem RESTful, resource disimpan di penyimpanan data; klien mengirim permintaan agar server melakukan tindakan tertentu (seperti membuat, mengambil, memperbarui, atau menghapus resource), dan server melakukan tindakan serta mengirim respons, sering kali dalam bentuk representasi resource yang ditentukan.

Di RESTful API Google, klien menentukan tindakan menggunakan kata kerja HTTP seperti POST, GET, PUT, atau DELETE. Ini menentukan resource dengan URI yang unik secara global untuk formulir berikut:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

Karena semua resource API memiliki URI unik yang dapat diakses HTTP, REST memungkinkan caching data dan dioptimalkan untuk berfungsi dengan infrastruktur terdistribusi web.

Sebaiknya lihat definisi metode dalam dokumentasi standar HTTP 1.1; definisi tersebut menyertakan spesifikasi untuk GET, POST, PUT, dan DELETE.

REST di Blogger JSON API

Operasi Blogger yang didukung dipetakan langsung ke kata kerja HTTP REST, seperti yang dijelaskan dalam Operasi Blogger JSON API.

Format spesifik untuk URI Blogger JSON API adalah:

https://www.googleapis.com/blogger/v2/users/userId
https://www.googleapis.com/blogger/v2/users/self
https://www.googleapis.com/blogger/v2/users/userId/blogs
https://www.googleapis.com/blogger/v2/users/self/blogs

https://www.googleapis.com/blogger/v2/blogs/blogId/posts
https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId
https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId/comments
https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId/comments/commentId
https://www.googleapis.com/blogger/v2/blogs/blogId/pages
https://www.googleapis.com/blogger/v2/blogs/blogId/pages/pageId

Penjelasan lengkap tentang URI yang digunakan dan hasil untuk setiap operasi yang didukung di API diringkas dalam dokumen Referensi JSON API Blogger.

Berikut adalah beberapa contoh cara kerjanya di Blogger JSON API.

Cantumkan blog yang hak aksesnya dimiliki oleh pengguna yang diautentikasi:

GET https://www.googleapis.com/blogger/v2/users/self/blogs?key=YOUR-API-KEY

Dapatkan postingan di blog code.blogger.com (yang memiliki ID blog 3213900):

GET https://www.googleapis.com/blogger/v2/blogs/3213900?key=YOUR-API-KEY

REST dari JavaScript

Anda dapat memanggil Blogger JSON API menggunakan REST dari JavaScript, menggunakan parameter kueri callback dan fungsi callback. Dengan begitu, Anda dapat menulis aplikasi lengkap yang menampilkan data Blogger tanpa perlu menulis kode sisi server.

Contoh berikut mengambil postingan dari blog code.blogger.com (setelah Anda mengganti YOUR-API-KEY dengan kunci API Anda).

<html>
  <head>
    <title>Blogger JSON API Example</title>
  </head>
  <body>
    <div id="content"></div>
    <script>
      function handleResponse(response) {
        document.getElementById("content").innerHTML += "<h1>" + response.title + "</h1>" + response.content;
      }
    </script>
    <script
    src="https://www.googleapis.com/blogger/v2/blogs/3213900/posts/8398240586497962757?callback=handleResponse&key=YOUR-API-KEY"></script>
  </body>
</html>

Format data

JSON

JSON (JavaScript Object Notation) adalah format data umum independen bahasa yang memberikan representasi teks sederhana untuk struktur data arbitrer. Untuk mendapatkan informasi lebih lanjut, lihat json.org.