Lưu ý quan trọng: Chúng tôi sẽ ngừng hỗ trợ API JSON phiên bản 2.0 kể từ ngày 30 tháng 9 năm 2024. Để đảm bảo ứng dụng của bạn vẫn hoạt động bình thường, hãy cập nhật những ứng dụng có dùng API JSON phiên bản 2.0 lên phiên bản API mới nhất. Đối với phiên bản mới nhất, hãy sử dụng các đường liên kết trong thanh điều hướng bên trái.
Tài liệu này giải thích cách bắt đầu sử dụng API JSON của Blogger.
Nội dung
Giới thiệu
Tài liệu này dành cho các nhà phát triển muốn viết ứng dụng có thể tương tác với API JSON của Blogger.
API JSON của Blogger mở rộng phiên bản 2.0 của API Dữ liệu của Blogger. Nếu bạn muốn truy xuất dữ liệu từ Blogger ở định dạng JSON thay vì XML, hãy sử dụng API JSON của Blogger. Nếu bạn muốn truy xuất dữ liệu ở định dạng XML, hãy sử dụng Blogger Data API.
Phiên bản API JSON của Blogger hiện chỉ có thể đọc; tuy nhiên, chúng tôi dự định thêm các chức năng đọc/ghi cũng như các chức năng khác. Bạn có thể yêu cầu các tính năng khác trên Diễn đàn trợ giúp của Blogger.
Trước khi bắt đầu
Tạo tài khoản Google
Đảm bảo bạn đã thiết lập Tài khoản Google. Bạn nên sử dụng một Tài khoản Google riêng cho mục đích phát triển và thử nghiệm để tránh bị mất dữ liệu do nhầm lẫn. Nếu đã có tài khoản thử nghiệm, bạn đã hoàn tất việc thiết lập; bạn có thể truy cập vào giao diện người dùng Blogger để thiết lập, chỉnh sửa hoặc xem dữ liệu thử nghiệm.
Làm quen với Blogger
Nếu bạn chưa quen với các khái niệm về Blogger, hãy đọc tài liệu này và thử nghiệm với giao diện người dùng trước khi bắt đầu lập trình. Tài liệu này giả định rằng bạn đã quen thuộc với Blogger, các khái niệm lập trình web và định dạng dữ liệu web.
Tìm hiểu về việc uỷ quyền cho các yêu cầu và xác định ứng dụng của bạn
Khi ứng dụng của bạn yêu cầu dữ liệu riêng tư, yêu cầu này phải được một người dùng đã xác thực có quyền truy cập vào dữ liệu đó cấp phép.
Khi ứng dụng của bạn yêu cầu dữ liệu công khai, yêu cầu này không cần được uỷ quyền nhưng phải đi kèm với một giá trị nhận dạng, chẳng hạn như khoá API.
Để biết thông tin về cách uỷ quyền cho các yêu cầu và sử dụng khoá API, hãy xem phần Uỷ quyền cho các yêu cầu và xác định ứng dụng của bạn trong tài liệu Sử dụng API.
Nền tảng API JSON của Blogger
Các khái niệm về Blogger
Blogger được xây dựng dựa trên 5 khái niệm cơ bản:
- Blog: Khái niệm gốc của API. Blog có các bài đăng và trang. Đây là vùng chứa cho siêu dữ liệu của blog như Tên blog và Nội dung mô tả.
- Bài đăng: Bài đăng trên blog là mục có thể xuất bản mà tác giả blog đã tạo. Thông tin này phải kịp thời, phản ánh những gì tác giả muốn công bố với thế giới ngay lúc này. Chúng tôi hiểu rằng theo thời gian, nội dung bài đăng trên blog sẽ trở nên lỗi thời và ít liên quan hơn.
- Nhận xét: Phần nhận xét là nơi mọi người (ngoài tác giả bài đăng trên blog) bày tỏ cảm nhận về nội dung mà tác giả đã viết. Mọi thứ từ gạch đến hoa bó.
- Trang: Trang là nơi chứa nội dung tĩnh, chẳng hạn như thông tin tiểu sử hoặc cách liên hệ với người dùng. Đây thường là thông tin không thay đổi theo thời gian.
- Người dùng: Người dùng là những người tương tác với Blogger, dù họ đóng vai trò là Tác giả, Quản trị viên hay chỉ là Người đọc. Đối với blog công khai, người đọc có thể ẩn danh, nhưng trên blog riêng tư, Blogger phải xác định được người đọc.
Mô hình dữ liệu Blogger JSON API
Tài nguyên là một thực thể dữ liệu riêng lẻ có giá trị nhận dạng duy nhất. API JSON của Blogger hoạt động trên 5 loại tài nguyên:
- Tài nguyên blog: Biểu thị một blog.
- Tài nguyên bài đăng: Biểu thị một bài đăng; mỗi Tài nguyên bài đăng là một phần tử con của Tài nguyên blog.
- Tài nguyên bình luận: Biểu thị một bình luận trên một bài đăng cụ thể; mỗi Tài nguyên bình luận là một phần tử con của Tài nguyên bài đăng.
- Tài nguyên trang: Biểu thị một trang tĩnh; mỗi Tài nguyên trang là một phần tử con của Tài nguyên blog.
- Tài nguyên người dùng: Biểu thị một người dùng không ẩn danh. Thuộc tính này dùng để xác định Tác giả của một Trang, Bài đăng hoặc Bình luận.
Mô hình dữ liệu API JSON của Blogger dựa trên các nhóm tài nguyên, được gọi là bộ sưu tập:
- Bộ sưu tập blog
- Bộ sưu tập Blog <span="apicollection"> bao gồm tất cả các Blog mà người dùng có quyền truy cập. Bạn có thể liệt kê Blog theo người dùng hoặc truy xuất một Blog theo mã nhận dạng.</span="apicollection">
- Bộ sưu tập bài đăng
- Bộ sưu tập bài đăng bao gồm tất cả Tài nguyên bài đăng trong một Tài nguyên blog cụ thể.
- Bộ sưu tập bình luận
- Bộ sưu tập bình luận bao gồm tất cả Tài nguyên bình luận trong một Tài nguyên bài đăng cụ thể.
- Bộ sưu tập trang
- Tập hợp trang bao gồm tất cả Tài nguyên trang trong một Tài nguyên blog cụ thể.
- Bộ sưu tập người dùng
- Tập hợp người dùng bao gồm tất cả Tài nguyên người dùng trên Blogger, do đó không thể được liệt kê. Người dùng có thể truy xuất Tài nguyên người dùng của riêng họ (nhưng không phải của người dùng nào khác) theo mã nhận dạng hoặc bằng cách sử dụng giá trị nhận dạng
self.
Các thao tác của Blogger JSON API
Bạn có thể gọi hai phương thức khác nhau trên các bộ sưu tập và tài nguyên trong API JSON của Blogger, như mô tả trong bảng sau.
| Hoạt động | Mô tả | Liên kết HTTP REST |
|---|---|---|
| list | Liệt kê tất cả tài nguyên trong một bộ sưu tập. | GET trên URI bộ sưu tập. |
| get | Lấy một tài nguyên cụ thể. | GET trên URI tài nguyên. |
Bảng dưới đây cho biết phương thức nào được hỗ trợ cho từng loại tài nguyên. Tất cả thao tác liệt kê và tìm nạp trên blog riêng tư đều yêu cầu xác thực.
Loại tài nguyên |
Các phương thức được hỗ trợ |
|
|---|---|---|
| list | get | |
| Blog | có | có |
| Bài đăng | có | có |
| Nhận xét | có | có |
| Trang | có | có |
| Số người dùng | không | có |
Kiểu gọi
Có một số cách để gọi API:
- Sử dụng trực tiếp REST hoặc từ JavaScript (không cần mã phía máy chủ)
- Sử dụng thư viện ứng dụng.
REST
REST là một kiểu kiến trúc phần mềm mang lại cách tiếp cận thuận tiện và nhất quán trong việc yêu cầu và sửa đổi dữ liệu.
Cụm từ REST là viết tắt của "Chuyển giao Trạng thái Trình bày". Trong ngữ cảnh của API của Google, cụm từ này đề cập đến việc sử dụng các động từ HTTP để truy xuất và sửa đổi các dạng trình bày của dữ liệu do Google lưu trữ.
Trong hệ thống RESTful, tài nguyên được lưu trữ trong một kho dữ liệu; ứng dụng gửi yêu cầu máy chủ thực hiện một hành động cụ thể (chẳng hạn như tạo, truy xuất, cập nhật hoặc xoá tài nguyên), sau đó máy chủ thực hiện hành động và gửi phản hồi, thường ở dạng bản trình bày của tài nguyên đã chỉ định.
Trong API RESTful của Google, ứng dụng chỉ định một hành động bằng cách sử dụng động từ HTTP như POST, GET, PUT hoặc DELETE. Phương thức này chỉ định một tài nguyên theo URI duy nhất trên toàn hệ thống có dạng như sau:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Vì tất cả các tài nguyên API đều có các URI có thể truy cập HTTP duy nhất, nên REST cho phép việc lưu trữ dữ liệu vào bộ nhớ đệm và được tối ưu hoá để hoạt động với cơ sở hạ tầng phân tán của trang web.
Bạn có thể thấy định nghĩa về phương thức trong tài liệu về các chuẩn HTTP 1.1 hữu ích; vì các định nghĩa này bao gồm nội dung đặc tả cho GET, POST, PUT và DELETE.
REST trong API JSON của Blogger
Các thao tác được hỗ trợ trên Blogger liên kết trực tiếp đến các động từ HTTP REST, như mô tả trong phần Thao tác API JSON của Blogger.
Định dạng cụ thể cho URI API JSON của Blogger là:
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
Nội dung giải thích đầy đủ về URI được sử dụng và kết quả cho từng thao tác được hỗ trợ trong API được tóm tắt trong tài liệu Tài liệu tham khảo về API JSON của Blogger.
Dưới đây là một số ví dụ về cách hoạt động của API JSON Blogger.
Liệt kê những blog mà người dùng đã xác thực có quyền truy cập:
GET https://www.googleapis.com/blogger/v2/users/self/blogs?key=YOUR-API-KEY
Tải các bài đăng trên blog code.blogger.com (có mã blog là 3213900):
GET https://www.googleapis.com/blogger/v2/blogs/3213900?key=YOUR-API-KEY
REST từ JavaScript
Bạn có thể gọi API JSON của Blogger bằng REST từ JavaScript, sử dụng tham số truy vấn callback và một hàm gọi lại. Điều này cho phép bạn viết các ứng dụng đa dạng thức hiển thị dữ liệu Blogger mà không cần viết mã phía máy chủ.
Ví dụ sau đây truy xuất một bài đăng từ blog code.blogger.com (sau khi bạn thay thế YOUR-API-KEY bằng khoá API của mình).
<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>Định dạng dữ liệu
JSON
JSON (Ký hiệu đối tượng JavaScript) là một định dạng dữ liệu phổ biến, độc lập về ngôn ngữ, cung cấp phần trình bày văn bản đơn giản của các cấu trúc dữ liệu tuỳ ý. Để biết thêm thông tin, hãy xem json.org.