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 chức năng không bị gián đoạn, hãy cập nhật các ứng dụng chạy API JSON phiên bản 2.0 lên phiên bản API mới nhất. Để dùng 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 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 này hiện ở chế độ chỉ đọc; tuy nhiên, chúng tôi đang lên kế hoạch về việc thêm tính năng đọc/ghi cũng như các khả năng khác. Vui lòng yêu cầu các tính năng khác trên Diễn đàn trợ giúp Blogger.
Trước khi bắt đầu
Tạo tài khoản Google
Đảm bảo rằng 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à kiểm thử để tránh việc bạn vô tình mất dữ liệu. Nếu đã có tài khoản thử nghiệm, thì bạn đã hoàn tất; bạn có thể truy cập 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 hiểu rõ về các khái niệm của 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, về các khái niệm lập trình web và các định dạng dữ liệu web.
Tìm hiểu về cách uỷ quyền cho yêu cầu và cách 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 đó 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 đó không cần được cấp phép, nhưng cần kèm theo 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 yêu cầu và xác định ứng dụng trong tài liệu Sử dụng API.
Hình nền API JSON của Blogger
Khái niệm về Blogger
Blogger được xây dựng dựa trên năm 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 thông tin meta của blog như Tên blog và Nội dung mô tả.
- Bài đăng: Bài đăng trên blog là một mục có thể xuất bản mà tác giả blog đã tạo. Đây là thông tin kịp thời, phản ánh những nội dung mà các tác giả hiện muốn xuất bản cho toàn thế giới. Có thể hiểu rằng khi thời gian trôi qua, blog đăng những nội dung theo thời gian và trở nên ít phù hợp hơn.
- Bình luận: Bình luận là nơi những người khác (không phải là tác giả của bài đăng trên blog) bày tỏ cảm xúc về nội dung mà tác giả đã viết. Tất cả từ gạch đến bó hoa.
- Trang: Trang là nơi dành cho 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 vô thời và không thay đổi thường xuyên.
- Người dùng: Người dùng là người tương tác với Blogger, có thể là họ đóng vai trò là Tác giả, Quản trị viên hoặc chỉ là một Người đọc. Đối với blog công khai, người đọc có thể ở chế độ ẩn danh, nhưng trên blog riêng tư, người đọc phải được Blogger xác định danh tính.
Mô hình dữ liệu API JSON của Blogger
Tài nguyên là một thực thể dữ liệu cá nhân có một 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: Đại diện cho blog.
- Tài nguyên bài đăng: Đại diện cho 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 nhận xét: Trình bày một nhận xét trên một bài đăng cụ thể; mỗi Tài nguyên nhận xét là một phần tử con của Tài nguyên bài đăng.
- Tài nguyên trang: Đại diện cho một trang tĩnh; mỗi Tài nguyên trang là một con của Tài nguyên blog.
- Tài nguyên người dùng: Đại diện cho người dùng không ẩn danh. Thuộc tính này dùng để xác định Tác giả của trang, bài đăng hoặc nhận xét.
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
- Một <span="apicollection">Bộ sưu tập blog bao gồm tất cả Blog mà một người dùng có quyền truy cập. Bạn có thể liệt kê các 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
- Một Bộ sưu tập bài đăng bao gồm tất cả các Tài nguyên bài đăng trong một Tài nguyên blog cụ thể.
- Thu thập bình luận
- Một Bộ sưu tập bình luận bao gồm tất cả cá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ể.
- Tập hợp người dùng
- Tập hợp người dùng bao gồm tất cả các Tài nguyên người dùng trên Blogger nên 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 chính họ (chứ không phải của người khác) theo mã nhận dạng hoặc bằng cách sử dụng giá trị nhận dạng
self.
Thao tác với API JSON của Blogger
Bạn có thể gọi hai phương thức khác nhau cho 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 | Nội dung 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. |
| nhận | Nhận một tài nguyên cụ thể. | GET trên URI tài nguyên. |
Bảng dưới đây cho biết các phương thức mà mỗi loại tài nguyên hỗ trợ. Tất cả các thao tác list (danh sách) và get 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ợ |
|
|---|---|---|
| danh sách | nhận | |
| Blog | có | có |
| Bài đăng | có | có |
| Bình luận | có | có |
| Trang | có | có |
| Số người dùng | no | có |
Kiểu gọi
Có một số cách để gọi API:
- Dùng REST trực tiếp hoặc qua JavaScript (không cần mã phía máy chủ)
- Sử dụng thư viện ứng dụng.
Kiến trúc chuyển trạng thái đại diện (REST)
REST là một kiểu kiến trúc phần mềm cung cấp phương pháp thuận tiện và nhất quán trong việc yêu cầu và sửa đổi dữ liệu.
Thuật ngữ REST là từ viết tắt của "Đại diện chuyển giao trạng thái." Khi nói đến API của Google, thuật ngữ này đề cập đến việc sử dụng động từ HTTP để truy xuất và sửa đổi cách trình bày dữ liệu do Google lưu trữ.
Trong hệ thống RESTful, các tài nguyên được lưu trữ trong kho dữ liệu; ứng dụng gửi yêu cầu để máy chủ thực hiện một thao tác cụ thể (chẳng hạn như tạo, truy xuất, cập nhật hoặc xoá tài nguyên) rồi máy chủ thực hiện thao tác đó rồi gửi phản hồi, thường ở dạng trình bày tài nguyên đã chỉ định.
Trong các API RESTful của Google, ứng dụng khách chỉ định một thao tác bằng động từ HTTP như POST, GET, PUT hoặc DELETE. Lớp này chỉ định tài nguyên theo một URI duy nhất trên toàn hệ thống có dạng 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 riêng biệt có thể truy cập qua HTTP, nên REST cho phép lưu 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 phối của web.
Bạn có thể thấy các định nghĩa về phương thức trong tài liệu về các tiêu chuẩn HTTP 1.1 hữu ích. Các định nghĩa này bao gồm các thông số kỹ thuật cho GET, POST, PUT và DELETE.
REST trong API JSON của Blogger
Các thao tác được hỗ trợ của Blogger liên kết trực tiếp với các động từ HTTP REST, như mô tả trong bài viết Các thao tác của 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
Bạn có thể xem phần giải thích đầy đủ về URI được sử dụng và kết quả cho mỗi thao tác được hỗ trợ trong API trong tài liệu Tài liệu tham khảo về API JSON của Blogger.
Dưới đây là một vài ví dụ về cách hoạt động của tính năng này trong API JSON của Blogger.
Liệt kê các 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, bằng cách dùng tham số truy vấn callback và hàm callback. Điều này cho phép bạn viết các ứng dụng phong phú hiển thị dữ liệu Blogger mà không cần viết bất kỳ mã phía máy chủ nào.
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).
<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 bả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.