Halaman ini diterjemahkan oleh Cloud Translation API.

Blogger JSON API: Memulai

Penting: Kami akan menghentikan dukungan untuk JSON API v2.0 pada 30 September 2024. Agar dapat terus berfungsi, update aplikasi yang mengandalkan JSON API v2.0 ke versi API terbaru. Untuk versi terbaru, gunakan link di menu navigasi sebelah kiri.

Dokumen ini menjelaskan cara mulai menggunakan Blogger JSON API.

Konten

Pengantar
Sebelum memulai
Latar belakang API JSON Blogger
Gaya panggilan
1. REST
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 dan bukan XML, gunakan Blogger JSON API. Jika Anda ingin mengambil data dalam format XML, gunakan Blogger Data API.

Versi Blogger JSON API ini saat ini hanya dapat dibaca. Namun, kami berencana menambahkan kemampuan baca/tulis, serta kemampuan lainnya. Jangan ragu untuk meminta fitur lainnya di Forum Bantuan Blogger.

Sebelum memulai

Membuat 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 secara tidak sengaja. Jika sudah memiliki akun pengujian, berarti Anda sudah siap. Anda dapat mengunjungi antarmuka pengguna Blogger untuk menyiapkan, mengedit, atau melihat data pengujian Anda.

Membiasakan diri dengan Blogger

Jika Anda belum memahami konsep Blogger, baca dokumen ini dan bereksperimenlah dengan antarmuka pengguna sebelum memulai kode. Dokumen ini mengasumsikan bahwa Anda sudah mengenal Blogger, memahami konsep pemrograman web, dan memahami format data web.

Pelajari cara memberi otorisasi permintaan dan mengidentifikasi aplikasi Anda

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

Jika aplikasi Anda meminta data publik, permintaan 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 Anda dalam dokumen Menggunakan 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 Deskripsi Blog.
Postingan: Postingan blog adalah item yang dapat dipublikasikan yang telah dibuat oleh penulis blog. Informasi ini dimaksudkan agar aktual dan mencerminkan apa yang ingin dipublikasikan penulisnya kepada dunia saat ini. Dipahami bahwa seiring berjalannya waktu, konten postingan blog akan mengalami usia dan menjadi kurang relevan.
Komentar: Komentar adalah tempat orang-orang selain penulis postingan blog bereaksi terhadap apa yang ditulis penulis. Mulai dari batu bata hingga buket.
Halaman: Halaman adalah tempat untuk konten statis, seperti informasi biografi, atau cara untuk menghubungi pengguna. Umumnya, ini adalah informasi abadi yang tidak sering berubah.
Pengguna: Pengguna adalah seseorang yang berinteraksi dengan Blogger, baik bertindak sebagai Penulis, Administrator, atau hanya Pembaca. Untuk blog publik, pembaca mungkin anonim, tetapi di blog pribadi, pembaca harus diidentifikasi oleh Blogger.

Model data JSON API Blogger

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

Referensi Blog: Mewakili blog.
Resource Postingan: Mewakili postingan; setiap Resource Postingan adalah turunan dari Resource Blog.
Resource Komentar: Mewakili komentar pada postingan tertentu; setiap Resource Komentar adalah turunan dari Resource Postingan.
Resource Halaman: Mewakili halaman statis; setiap Resource Halaman adalah turunan dari Resource Blog.
Sumber Daya Pengguna: Mewakili pengguna non-anonim. Atribut ini digunakan untuk mengidentifikasi Penulis Halaman, Postingan, atau Komentar.

Sumber Daya Blog memiliki dua jenis sumber daya 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">Koleksi Blog terdiri dari semua Blog yang hak aksesnya dimiliki pengguna. Anda dapat mencantumkan Blog menurut pengguna, atau mengambil satu Blog menurut ID.</span="apicollection">
Koleksi Postingan: Koleksi Postingan terdiri dari semua Referensi Postingan dalam Referensi Blog tertentu.
Koleksi Komentar: Koleksi Komentar terdiri dari semua Referensi Komentar dalam Referensi Postingan tertentu.
Koleksi Halaman: Koleksi Halaman terdiri dari semua Referensi Halaman dalam Referensi Blog tertentu.
Koleksi Pengguna: Koleksi Pengguna terdiri atas semua Referensi Pengguna di Blogger, sehingga tidak dapat dicantumkan. Pengguna dapat mengambil Resource Pengguna mereka sendiri (tetapi milik orang lain) menurut ID, atau dengan menggunakan ID self.

Operasi JSON API Blogger

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

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

Tabel di bawah menunjukkan metode yang didukung oleh setiap jenis resource. Semua operasi list 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	no	ya

Gaya panggilan

Ada beberapa cara untuk memanggil API:

Menggunakan REST secara langsung atau dari JavaScript (tidak memerlukan kode sisi server)
Menggunakan library klien.

REST

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

Istilah REST adalah singkatan dari "Representational State Transfer". Dalam konteks Google API, hal ini mengacu 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 dan 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. Kode ini menetapkan resource berdasarkan URI unik global untuk form 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.

Anda dapat memperoleh manfaat dari definisi metode dalam dokumentasi standar HTTP 1.1; dokumentasi 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 JSON API Blogger.

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 pengguna terautentikasi:

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, dengan menggunakan parameter kueri callback dan fungsi callback. Dengan demikian, Anda dapat menulis aplikasi lengkap yang menampilkan data Blogger tanpa perlu menulis kode sisi server apa pun.

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 informasi selengkapnya, lihat json.org.