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, perbarui aplikasi Anda yang mengandalkan JSON API v2.0 ke versi API terbaru. Untuk versi terbaru, gunakan link di menu navigasi samping kiri.

Dokumen ini menjelaskan cara memulai penggunaan Blogger JSON API.

Daftar Isi

Pengantar
Sebelum memulai
Latar belakang Blogger JSON API
Gaya panggilan
1. REST
Format data
1. JSON

Pengantar

Dokumen ini ditujukan bagi 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 Blogger JSON API ini saat ini hanya dapat dibaca; namun, kami berencana untuk menambahkan kemampuan baca/tulis, serta kemampuan lainnya. Jangan ragu untuk meminta fitur lain 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 yang tidak disengaja. Jika sudah memiliki akun pengujian, Anda sudah siap. Anda dapat membuka antarmuka pengguna Blogger untuk menyiapkan, mengedit, atau melihat data pengujian.

Memahami Blogger

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

Pelajari cara memberikan otorisasi pada permintaan dan mengidentifikasi aplikasi Anda

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

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

Untuk informasi tentang cara memberikan otorisasi pada permintaan dan menggunakan kunci API, lihat Memberikan otorisasi pada permintaan dan mengidentifikasi aplikasi Anda dalam dokumen Menggunakan API.

Latar belakang JSON API Blogger

Konsep Blogger

Blogger dibuat berdasarkan lima konsep dasar:

Blog: Konsep root API. Blog memiliki postingan dan halaman. Ini adalah penampung untuk meta-informasi blog seperti Nama Blog dan Deskripsi.
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 saat ini. Kami memahami bahwa seiring waktu, konten postingan blog akan menjadi usang dan kurang relevan.
Komentar: Komentar adalah tempat orang selain penulis postingan blog bereaksi terhadap apa yang telah ditulis penulis. Semuanya, mulai dari bata hingga buket.
Halaman: Halaman adalah tempat untuk konten statis, seperti informasi biografis, atau cara menghubungi pengguna. Informasi ini biasanya merupakan informasi yang tidak lekang oleh waktu dan tidak sering berubah.
Pengguna: Pengguna adalah seseorang yang berinteraksi dengan Blogger, baik sebagai Penulis, Administrator, maupun hanya sebagai Pembaca. Untuk blog publik, pembaca dapat bersifat anonim, tetapi di blog pribadi, pembaca harus diidentifikasi oleh Blogger.

Model data Blogger JSON API

Resource adalah entitas 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: Merepresentasikan komentar pada postingan tertentu; setiap Resource Komentar adalah turunan dari Resource Postingan.
Resource Halaman: Merepresentasikan halaman statis; setiap Resource Halaman adalah turunan dari Resource Blog.
Users Resource: Mewakili pengguna non-anonim. Kolom ini digunakan untuk mengidentifikasi Penulis Halaman, Postingan, atau Komentar.

Resource Blog memiliki dua jenis resource turunan, Halaman dan Postingan.
Resource Postingan dapat memiliki turunan Resource Komentar. — Ringkasan hubungan antar-resource

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

Koleksi Blog: Kumpulan Blog <span="apicollection"> terdiri dari semua Blog yang memiliki hak akses pengguna. Anda dapat mencantumkan Blog menurut pengguna, atau mengambil satu Blog menurut ID.</span="apicollection">
Koleksi Postingan: Koleksi Postingan terdiri dari semua Resource Postingan dalam Resource Blog tertentu.
Koleksi Komentar: Kumpulan Komentar terdiri dari semua Resource Komentar dalam Resource Postingan tertentu.
Koleksi Halaman: Kumpulan Halaman terdiri dari semua Resource Halaman dalam Resource Blog tertentu.
Koleksi Pengguna: Koleksi Pengguna terdiri dari semua Referensi Pengguna di Blogger, sehingga tidak dapat dicantumkan. Pengguna dapat mengambil Resource Pengguna mereka sendiri (tetapi bukan milik orang lain) berdasarkan ID, atau dengan menggunakan ID self.

Operasi Blogger JSON API

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

Operasi	Deskripsi	Pemetaan HTTP REST
list	Mencantumkan semua resource dalam koleksi.	`GET` di URI koleksi.
get	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
	list	get
Blog	ya	ya
Postingan	ya	ya
Komentar	ya	ya
Halaman	ya	ya
Pengguna	tidak	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, REST 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 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. Kata kerja ini menentukan resource berdasarkan URI yang unik secara 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 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 URI yang digunakan dan hasil untuk setiap operasi yang didukung di API diringkas dalam dokumen Referensi Blogger JSON API.

Berikut beberapa contoh cara kerjanya di Blogger JSON API.

Cantumkan blog yang memiliki hak akses 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, menggunakan parameter kueri callback dan fungsi callback. Hal ini memungkinkan Anda menulis aplikasi lengkap yang menampilkan data Blogger tanpa 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.