Tài liệu này giải thích cách bắt đầu sử dụng API 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 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 tổng hợp trên blog như tên blog và 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 của API 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 về bình luận: Biểu thị một bình luận về một bài đăng cụ thể; mỗi tài nguyên bình luận là một tài nguyên 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 phần tử con của một tài nguyên blog.
- Tài nguyên người dùng: Thể hiện 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 nhận xét.
Mô hình dữ liệu API 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 <tspanspanquot;apicollection">blog 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
- Bộ sưu 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 blog cụ thể.
- Bộ sưu tập bình luận
- Tập hợ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
- Một bộ sưu tập trang bao gồm tất cả tài nguyên về các 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 và 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.
Hoạt động của Blogger API
Bạn có thể gọi một số phương thức khác nhau trên bộ sưu tập và tài nguyên trong API 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. |
| getByUrl | Lấy tài nguyên, tra cứu bằng URL. | GET có URL được truyền vào dưới dạng một thông số. |
| getByPath | Lấy tài nguyên bằng cách tra cứu tài nguyên theo đường dẫn của tài nguyên đó. | GET với Đường dẫn được truyền vào dưới dạng một thông số. |
| listByUser | Liệt kê các tài nguyên thuộc sở hữu của một Người dùng. | GET trên bộ sưu tập của người dùng. |
| search | Tìm kiếm tài nguyên, dựa trên tham số truy vấn. | GET trên URL tìm kiếm, trong đó cụm từ tìm kiếm được chuyển vào dưới dạng thông số. |
| chèn | Tạo tài nguyên trong một bộ sưu tập. | POST trên URI bộ sưu tập. |
| xóa | Xoá tài nguyên. | DELETE trên URI tài nguyên. |
| bản vá | Cập nhật tài nguyên bằng cách sử dụng ngữ nghĩa của Bản vá. | PATCH trên URI tài nguyên. |
| cập nhật | Cập nhật tài nguyên. | PUT 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 | getByUrl | getByPath | listByUser | tìm kiếm | chèn | xoá | bản vá | cập nhật | |
| Blog | no | có | có | no | có | no | no | no | no | no |
| Bài đăng | có | có | no | có | no | có | có | có | có | có |
| Nhận xét | có | có | no | no | no | no | no | no | no | no |
| Trang | có | có | no | no | no | no | no | no | no | no |
| Số người dùng | no | có | no | no | no | no | no | no | no | no |
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 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 trên API Blogger.
Định dạng cụ thể cho URI API của Blogger là:
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
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 Blogger.
Ví dụ
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/v3/users/self/blogs?key=YOUR-API-KEY
Xem các bài đăng trên blog code.blogger.com có mã blog là 3213900:
GET https://www.googleapis.com/blogger/v3/blogs/3213900?key=YOUR-API-KEY
REST từ JavaScript
Bạn có thể gọi API Blogger qua JavaScript bằng cách sử dụng tham số truy vấn callback và cung cấp hàm callback.
Khi trình duyệt tải tập lệnh, hàm callback sẽ được thực thi và phản hồi sẽ được cung cấp cho hàm callback. Phương pháp này cho phép bạn ghi các ứng dụng đa dạng thức có chức năng hiển thị dữ liệu trên Blogger mà không yêu cầu mã phía máy chủ.
Ví dụ sau đây truy xuất một bài đăng trên blog code.blogger.com sau khi bạn thay thế YOUR-API-KEY bằng khoá API.
<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>
Đị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.