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 API dữ liệu của Blogger.
Phiên bản API JSON của Blogger này hiện ở chế độ chỉ đọc; tuy nhiên, chúng tôi dự định thêm các khả năng đọc/ghi cũng như các khả năng khác. Hãy 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 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ử để bảo vệ bản thân khỏi việc vô tình làm 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 của mình.
Làm quen với Blogger
Nếu bạn chưa quen với các khái niệm trên 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, 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
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 cần phải có giá trị nhận dạng đi kèm, chẳng hạn như khoá API.
Để biết thông tin về cách uỷ quyền yêu cầu và sử dụng khoá API, hãy xem nội dung Uỷ quyền yêu cầu và xác định ứng dụng trong tài liệu Sử dụng API.
Nền API JSON của Blogger
Các 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ó 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. Thông tin này có nghĩa là kịp thời, phản ánh những gì tác giả muốn xuất bản ra thế giới. Chúng tôi hiểu rằng khi thời gian trôi qua, blog sẽ đăng nội dung theo thời gian và trở nên ít gần gũi hơn.
- Bình luận: Bình luận là nơi những người không phải là tác giả bài đăng trên blog phản ứng với những gì tác giả đã viết. Mọi thứ từ gạch đến bó hoa.
- Trang: Trang là nơi lưu trữ nội dung tĩnh, chẳng hạn như thông tin tiểu sử hoặc các cách liên hệ với người dùng. Đây thường là thông tin không lỗi 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ể họ là tác giả, quản trị viên hoặc chỉ là người đọc. Đối với các blog công khai, độc giả có thể ẩn danh, nhưng trên các blog riêng tư, Blogger phải xác định được độc giả.
Mô hình dữ liệu API JSON cho Blogger
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 trên blog: Đại diện cho 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à phần tử con của một Tài nguyên blog.
- Tài nguyên nhận xét: Trình bày nhận xét về một bài đăng cụ thể; mỗi Tài nguyên về nhận xét là phần tử con của một 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 phần tử con của Tài nguyên blog.
- Tài nguyên người dùng: Đại diện cho một người dùng không ẩn danh. URL này được 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 Google dựa trên các nhóm tài nguyên, gọi là bộ sưu tập:
- Bộ sưu tập blog
- Bộ sưu tập <tspanspanquot;apicollection">Blogs bao gồm tất 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=%quot;apicollection">
- Bộ sưu tập bài đăng
- Tuyển tập bài đăng bao gồm tất cả Tài nguyên về bài đăng trong một Tài nguyên trên blog.
- Bộ sưu tập nhận xét
- Bộ sưu tập nhận xét bao gồm tất cả Tài nguyên nhận xét trong một Tài nguyên bài đăng cụ thể.
- Thu thập trang
- Tuyển tập trang bao gồm tất cả Tài nguyên về trang trong một Tài nguyên trên blog.
- Bộ sưu tập người dùng
- Bộ sưu tậ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ể liệt kê. Người dùng có thể truy xuất Tài nguyên người dùng của riêng mình (chứ không phải ai khác) theo mã hoặc bằng cách sử dụng mã nhận dạng
self.
Các thao tác API JSON trên Blogger
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 | 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. |
| tải | Lấy một tài nguyên cụ thể. | GET trên URI tài nguyên. |
Bảng dưới đây cho thấy các phương thức được hỗ trợ theo từng loại tài nguyên. Mọi thao tác danh sách và tải 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 | tải | |
| Blog | có | có |
| Bài đăng | có | có |
| Nhận xét | 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:
- Sử dụng REST trực tiếp hoặc từ 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 cách tiếp cận thuận tiện và nhất quán để yêu cầu và sửa đổi dữ liệu.
Thuật ngữ REST là viết tắt của "Representational State Transfer (dụ thể trạng thái đại diện)." Trong bối cảnh của Google API, thuật ngữ này đề cập đến việc sử dụng động từ HTTP để truy xuất và sửa đổi bản trình bày dữ liệu được Google lưu trữ.
Trong hệ thống RESTful, tài nguyên được lưu trữ trong kho lưu trữ 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) và máy chủ thực hiện hành động đó và 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 hành động bằng cách sử dụng động từ HTTP như POST, GET, PUT hoặc DELETE. Công cụ này chỉ định tài nguyên theo URI duy nhất trên toàn cầu có dạng sau:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Vì tất cả tài nguyên API đều có các URI riêng biệt có thể truy cập được, nên REST cho phép việc 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 định nghĩa về phương thức trong tài liệu về các chuẩn HTTP 1.1 hữu ích, bao gồm cả 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 Blogger hỗ trợ sẽ ánh xạ trực tiếp đến động từ HTTP REST, như đã mô tả trong phần các 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
Tài liệu giải thích đầy đủ về các 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.
Sau đây là một số ví dụ về cách thức hoạt động của API này trong Blogger JSON API.
Liệt kê các blog mà người dùng được xác thực có quyền truy cập:
GET https://www.googleapis.com/blogger/v2/users/self/blogs?key=YOUR-API-KEY
Xem các bài đăng trên blog code.blogger.com (có mã blog 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à hàm callback. Tính năng này cho phép bạn ghi 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 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 tùy ý. Để biết thêm thông tin, hãy xem json.org.