Dokumen ini menjelaskan cara memulai penggunaan Blogger API.
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, berarti Anda sudah siap. Anda dapat mengunjungi antarmuka pengguna Blogger untuk menyiapkan, mengedit, atau melihat data pengujian.
Mengenal Blogger
Jika Anda belum memahami konsep Blogger, baca dokumen ini dan bereksperimenlah dengan antarmuka pengguna sebelum mulai membuat kode. Dokumen ini mengasumsikan bahwa Anda sudah familier dengan Blogger, konsep pemrograman web, dan format data web.
Pelajari cara mengizinkan permintaan dan mengidentifikasi aplikasi Anda
Saat aplikasi Anda meminta data pribadi, permintaan tersebut harus diizinkan oleh pengguna terautentikasi yang memiliki akses ke data tersebut.
Saat aplikasi Anda meminta data publik, permintaan ini tidak perlu diotorisasi, tetapi harus disertai dengan ID, seperti kunci API.
Untuk informasi tentang cara mengizinkan permintaan dan menggunakan kunci API, lihat Memberi otorisasi permintaan dan mengidentifikasi aplikasi Anda di dokumen Menggunakan 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 dibuat oleh penulis blog. Informasi ini dimaksudkan agar tepat waktu, mencerminkan apa yang ingin dipublikasikan penulisnya sekarang. Dapat dipahami bahwa seiring berjalannya waktu, konten postingan blog akan terus bertambah dan menjadi kurang relevan.
- Komentar: Komentar adalah tempat orang selain penulis postingan blog bereaksi terhadap apa yang telah ditulis oleh penulis. Segala pengalaman, dari batu bata hingga buket.
- Halaman: Halaman adalah tempat untuk konten statis, seperti informasi biografis, atau cara untuk menghubungi pengguna. Ini biasanya adalah informasi abadi yang tidak terlalu sering berubah.
- Pengguna: Pengguna adalah seseorang yang berinteraksi dengan Blogger, baik sebagai Penulis, Administrator, maupun Pembaca saja. Untuk blog publik, pembaca mungkin anonim, tetapi di blog pribadi, pembaca harus diidentifikasi oleh Blogger.
Model data Blogger API
Resource adalah entity data individual dengan ID unik. Blogger JSON API beroperasi di lima jenis resource:
- Resource blog: Mewakili blog.
- Resource postingan: Mewakili postingan; setiap resource postingan adalah turunan dari resource blog.
- Resource komentar: Mewakili 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. Kunci ini digunakan untuk mengidentifikasi Penulis halaman, postingan, atau komentar.
![Resource blog ini memiliki dua jenis resource turunan, yaitu halaman dan postingan.
Resource postingan dapat memiliki turunan resource komentar.](https://developers-dot-devsite-v2-prod.appspot.com/static/blogger/docs/3.0/blogs-posts-comments.png?authuser=7&hl=id)
Model data Blogger API didasarkan pada grup resource, yang disebut koleksi:
- Koleksi blog
- Kumpulan <span="apicollection">blog terdiri dari semua blog yang haknya dapat diakses oleh pengguna. Anda dapat mencantumkan blog menurut pengguna, atau mengambil satu blog berdasarkan ID.</span="apicollection">
- Koleksi postingan
- Koleksi postingan terdiri dari semua referensi postingan dalam resource blog tertentu.
- Koleksi komentar
- Kumpulan komentar terdiri dari semua resource komentar dalam resource postingan tertentu.
- Koleksi halaman
- Koleksi halaman terdiri dari semua resource halaman dalam resource blog tertentu.
- Koleksi Pengguna
- Kumpulan pengguna terdiri dari semua resource 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 API
Anda dapat memanggil sejumlah metode yang berbeda pada koleksi dan resource di Blogger API, seperti yang 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. |
getByUrl | Mendapatkan sumber daya, mencarinya dengan URL. | GET dengan URL yang diteruskan sebagai parameter. |
getByPath | Mendapatkan resource dengan mencarinya melalui 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 di URL Penelusuran, dengan kueri yang diteruskan sebagai parameter. |
sisipkan | Membuat resource dalam koleksi. | POST pada URI koleksi. |
hapus | Menghapus resource. | DELETE pada URI resource. |
patch | Mengupdate resource, menggunakan semantik Patch. | PATCH pada URI resource. |
info terbaru | Memperbarui resource. | PUT pada URI resource. |
Tabel di bawah menampilkan metode yang didukung oleh setiap jenis resource. Semua operasi daftar dan dapatkan di blog pribadi memerlukan autentikasi.
Jenis Resource |
Metode yang Didukung |
|||||||||
---|---|---|---|---|---|---|---|---|---|---|
daftar | dapatkan | getByUrl | getByPath | listByUser | telusuri | sisipkan | hapus | patch | info terbaru | |
Blog | no | ya | ya | no | ya | tidak | tidak | tidak | tidak | no |
Postingan | ya | ya | no | ya | no | ya | ya | ya | ya | ya |
Komentar | ya | ya | tidak | tidak | tidak | tidak | tidak | tidak | tidak | no |
Halaman | ya | ya | tidak | tidak | tidak | tidak | tidak | tidak | tidak | no |
Pengguna | no | ya | tidak | tidak | tidak | tidak | tidak | tidak | tidak | no |
Gaya panggilan
Ada beberapa cara untuk memanggil API:
- Menggunakan REST secara langsung atau dari JavaScript (kode sisi server tidak diperlukan)
- 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 mengubah 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
. Ini menetapkan resource melalui URI yang unik secara global dengan bentuk 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 API
Operasi Blogger yang didukung dipetakan langsung ke kata kerja HTTP REST, seperti yang dijelaskan dalam operasi Blogger API.
Format khusus 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 dalam API diringkas dalam dokumen Referensi Blogger API.
Contoh
Cantumkan blog yang hak aksesnya dimiliki pengguna terautentikasi:
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 memberikan fungsi callback.
Saat browser memuat skrip, fungsi callback akan dieksekusi dan respons diberikan ke fungsi callback. Pendekatan ini memungkinkan Anda untuk 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 informasi selengkapnya, lihat json.org.