Blogger API: Memulai

Dokumen ini menjelaskan cara mulai menggunakan Blogger API.

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 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 Deskripsi 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 API

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

  • Resource blog: 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: Merepresentasikan 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.
Resource blog memiliki dua jenis resource turunan, yaitu halaman dan postingan.
          Resource postingan mungkin memiliki turunan resource komentar.
Ringkasan hubungan antar-resource

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

Koleksi blog
<span="apicollection">koleksi blog terdiri dari semua blog yang hak aksesnya dimiliki pengguna. Anda dapat mencantumkan blog berdasarkan 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 bukan orang lain) menurut ID, atau dengan menggunakan ID self.

Operasi Blogger API

Anda dapat memanggil sejumlah metode yang berbeda di koleksi dan resource di Blogger 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.
getByUrl Mendapatkan resource, mencarinya berdasarkan URL. GET dengan URL yang diteruskan sebagai parameter.
getByPath Mendapatkan resource dengan mencarinya berdasarkan jalurnya. GET dengan Jalur yang diteruskan sebagai parameter.
listByUser Mencantumkan resource yang dimiliki oleh Pengguna. GET pada koleksi milik pengguna.
search Menelusuri resource, berdasarkan parameter kueri. GET pada URL Penelusuran, dengan kueri diteruskan sebagai parameter.
masukkan Buat fasilitas dalam koleksi. POST di URI koleksi.
hapus Menghapus fasilitas. DELETE pada URI resource.
patch Mengupdate resource, menggunakan semantik Patch. PATCH pada URI resource.
perbarui Mengupdate resource. PUT 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 getByUrl getByPath listByUser telusuri masukkan hapus patch perbarui
Blog tidak ya ya tidak ya tidak tidak tidak tidak tidak
Postingan ya ya tidak ya tidak ya ya ya ya ya
Komentar ya ya tidak tidak tidak tidak tidak tidak tidak tidak
Halaman ya ya tidak tidak tidak tidak tidak tidak tidak tidak
Pengguna tidak ya tidak tidak tidak tidak tidak tidak tidak tidak

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 API

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

Format spesifik untuk URI Blogger API adalah:

https://www.googleapis.com/blogger/v3/users/userId
https://www.googleapis.com/blogger/v3/users/self
https://www.googleapis.com/blogger/v3/users/userId/blogs
https://www.googleapis.com/blogger/v3/users/self/blogs
https://www.googleapis.com/blogger/v3/blogs/blogId
https://www.googleapis.com/blogger/v3/blogs/byurl
https://www.googleapis.com/blogger/v3/blogs/blogId/posts
https://www.googleapis.com/blogger/v3/blogs/blogId/posts/bypath
https://www.googleapis.com/blogger/v3/blogs/blogId/posts/search
https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId
https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId/comments
https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId/comments/commentId
https://www.googleapis.com/blogger/v3/blogs/blogId/pages
https://www.googleapis.com/blogger/v3/blogs/blogId/pages/pageId

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

Contoh

Cantumkan blog yang hak aksesnya dimiliki oleh pengguna yang diautentikasi:

GET https://www.googleapis.com/blogger/v3/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/v3/blogs/3213900?key=YOUR-API-KEY

REST dari JavaScript

Anda dapat memanggil Blogger API dari JavaScript menggunakan parameter kueri callback dan dengan menyediakan fungsi callback. Saat browser memuat skrip, fungsi callback akan dieksekusi dan respons diberikan ke fungsi callback. Pendekatan ini memungkinkan Anda menulis aplikasi lengkap yang menampilkan data Blogger tanpa memerlukan 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 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/v3/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.