WordPress API là gì? Sử dụng như thế nào?
Mục Lục
1.Wordpress API là gì?
WordPress API là một tập hợp các giao diện lập trình ứng dụng (API) cho phép các nhà phát triển truy cập và tương tác với dữ liệu của trang web WordPress từ các ứng dụng bên ngoài. Các API này cung cấp các phương thức để truy xuất và thay đổi dữ liệu của WordPress như bài đăng, trang, danh mục, tài khoản người dùng, tệp đính kèm và nhiều hơn nữa. WordPress API được cung cấp dưới dạng RESTful API (API dựa trên REST) và được thiết kế để tương thích với các ngôn ngữ lập trình phổ biến như PHP, JavaScript, Python và Ruby. Các nhà phát triển có thể sử dụng API này để phát triển các ứng dụng di động, các trình quản lý nội dung tùy chỉnh, các trình đọc RSS và các ứng dụng khác để tương tác với dữ liệu của trang web WordPress.
Ngoài WordPress REST API, WordPress cũng cung cấp một số API khác để cho các nhà phát triển có thể tùy chỉnh trang web của họ. Dưới đây là một số API phổ biến khác của WordPress:
- XML-RPC API: Đây là một API đơn giản dựa trên XML cho phép các ứng dụng bên ngoài tương tác với trang web WordPress. API này cho phép bạn đăng bài viết, cập nhật các thông tin người dùng và thực hiện một số tác vụ khác.
- WP-CLI: WP-CLI là một công cụ dòng lệnh cho phép bạn quản lý trang web WordPress từ xa. WP-CLI cho phép bạn thực hiện các tác vụ như tạo bài viết, cài đặt plugin và thực hiện các tác vụ khác mà không cần truy cập trực tiếp vào giao diện quản trị của WordPress.
- WordPress Plugin API: API này cho phép các nhà phát triển tạo các plugin WordPress. Plugin là các mã lệnh được cài đặt trên trang web WordPress để mở rộng chức năng của nó. Plugin API cho phép bạn thêm các trang quản trị mới, thêm các chức năng mới và thay đổi giao diện người dùng của trang web WordPress.
- WordPress Theme API: API này cho phép các nhà phát triển tạo các theme WordPress. Theme là các giao diện người dùng được cài đặt trên trang web WordPress để thay đổi giao diện của nó. Theme API cho phép bạn tạo các template, thay đổi giao diện người dùng và thêm các chức năng mới vào theme của bạn.
- Metadata API: API này cho phép các nhà phát triển lưu trữ và truy xuất các dữ liệu phụ của các bài viết và các trang trên trang web WordPress. Ví dụ, các dữ liệu phụ này có thể là một số thông tin bổ sung về tác giả, ngày đăng, tác giả của bài viết, v.v.
- Options API: API này cho phép các nhà phát triển tạo và lưu trữ các tùy chọn cấu hình cho trang web WordPress. Ví dụ, các tùy chọn này có thể là một số thông tin về cấu hình giao diện, các thông tin liên hệ hoặc các tùy chọn cho các plugin.
- Shortcode API: API này cho phép các nhà phát triển tạo các mã shortcode tùy chỉnh. Shortcode là các mã được sử dụng để thêm các chức năng đặc biệt vào các bài viết và trang WordPress. Shortcode API cho phép bạn tạo các shortcode tùy chỉnh để thêm các chức năng đặc biệt vào trang web WordPress của bạn.
Tất cả các API này đều giúp các nhà phát triển tạo các ứng dụng WordPress tùy chỉnh và mở rộng chức năng của trang web WordPress.
2. Về WordPress API?
Trước đây, bạn cần một plugin WordPress để truy cập API WordPress JSON REST. Tuy nhiên, kể từ Phiên bản 4.4 , API WordPress này đã trở thành một phần của phần mềm cốt lõi. Như vậy, để sử dụng API REST, bạn chỉ cần biết cách tương tác với nó, nghĩa là sử dụng bốn loại phương thức HTTP khác nhau như một phần yêu cầu của bạn:
- GET : Với phương pháp này, bạn có thể lấy thông tin từ máy chủ.
- POST : Điều này cho phép bạn gửi thông tin đến máy chủ được đề cập.
- PUT : Với phương thức put , bạn có thể chỉnh sửa và cập nhật dữ liệu hiện có.
- Delete : Điều này cho phép bạn xóa thông tin.
Ví dụ, xem xét điều gì sẽ xảy ra khi bạn truy cập trang đăng nhập WordPress của mình. Trình duyệt của bạn gửi yêu cầu GET tới máy chủ, máy chủ này sẽ xử lý yêu cầu đó bằng API của chính nó. Sau khi tải trang, bạn nhập thông tin đăng nhập của mình và gửi chúng qua yêu cầu POST . Nếu bạn muốn thay đổi mật khẩu của mình, nó liên quan đến phương thức PUT , trong khi xóa hoàn toàn tài khoản của bạn sẽ sử dụng DELETE .
3. Cách bắt đầu sử dụng WordPress REST API
Để truy cập WordPress REST API, cần bắt đầu bằng:
yoursite.com/wp-json/wp/v2Sau đó, thêm vào URL này để truy cập nhiều loại dữ liệu khác nhau. Ví dụ: bạn có thể tra cứu hồ sơ người dùng cụ thể qua route sau:
yoursite.com/wp-json/wp/v2/users/4567Trong trường hợp này, “4567” là ID người dùng duy nhất cho profile bạn muốn xem. Nếu bạn bỏ qua ID đó, thay vào đó, bạn sẽ thấy danh sách tất cả những người dùng trên trang web của mình:
Bạn có thể sử dụng cùng route cơ bản để xem các loại dữ liệu khác, như các bài đăng hoặc trang của bạn. Bạn cũng có thể tìm kiếm các tập hợp con của dữ liệu đáp ứng các tiêu chí nhất định. Ví dụ: bạn có thể truy xuất tất cả các bài đăng chứa một cụm từ cụ thể bằng cách sử dụng URL này:
yoursite.com/wp-json/wp/v2/posts?=search[keyword]Đây chỉ là một minh họa đơn giản. Hầu như không có giới hạn nào đối với những gì bạn thực sự có thể làm khi sử dụng WordPress REST API. Nếu bạn muốn tìm hiểu thêm, bạn nên bắt đầu với các tài nguyên sau:
Tài liệu tham khảo về WordPress REST API
- REST API Handbook: Đây là một tài nguyên WordPress chính thức ghi lại tất cả các loại thông tin về API REST. Bạn sẽ tìm thấy danh sách các endpoint mà bạn có thể sử dụng, cũng như thông tin chi tiết về một số khía cạnh cấu trúc của REST API mà chúng tôi chưa đề cập đến ở đây.
- W3Schools tutorials: Mặc dù tài nguyên này không dành riêng cho REST API, nhưng nó cung cấp các hướng dẫn hữu ích có thể giúp bạn tìm hiểu các khái niệm chính, chẳng hạn như phương thức HTTP và JSON.
- The Ultimate Guide to the WordPress REST API: E-book miễn phí này từ WP Engine chứa nhiều thông tin và ví dụ thực tế. Ngoài ra, nó sẽ hướng dẫn bạn cách hoàn thành một số tác vụ cơ bản (và nâng cao hơn).
ĐỂ dễ hiểu hơn chúng ta có thể tham khảo như sau:
Bước 1: Truy cập API REST
Bạn có thể ‘truy cập’ WordPress REST API từ bất kỳ ứng dụng nào có thể gửi điểm cuối HTTP. Ví dụ: nếu bạn nhập lệnh sau trong trình duyệt yêu thích của mình, bạn sẽ nhận được danh sách các bài đăng WordPress của mình ở định dạng JSON:
GET yourwebsiteurl.com/wp-json/wp/v2/posts
Tuy nhiên, bạn cần thay thế URL giữ chỗ bằng URL của trang web của riêng bạn. Bạn cũng sẽ cần sử dụng phiên bản WordPress lớn hơn 4.4 để yêu cầu API REST hoạt động (điều mà bạn nên làm).
Bước 2: Tìm nạp một bài đăng cụ thể bằng API REST
Lệnh cuối cùng bạn đã chạy sẽ trả về danh sách tất cả các bài đăng trên WordPress của bạn, bao gồm cả ID bài đăng của chúng. Để tìm nạp một bài đăng cụ thể bằng ID của nó, bạn sẽ sử dụng một điểm cuối như sau:
GET yourwebsiteurl.com/wp-json/wp/v2/posts/535
Ví dụ: điều này sẽ lý tưởng để hiển thị một bài đăng WordPress cụ thể được dịch trong một ứng dụng dành cho thiết bị di động. Tuy nhiên, WordPress REST API cho phép bạn tìm nạp tất cả các loại dữ liệu từ WordPress, vì vậy các ứng dụng thực tế của nó rất linh hoạt.
Tuy nhiên, giả sử bạn muốn sử dụng API REST để thêm siêu dữ liệu vào một bài đăng đã chọn thay vì chỉ tìm nạp nó. Nói cách khác, bạn sẽ sử dụng phương thức POST thay vì GET
Bước 3: Thêm siêu dữ liệu vào một bài đăng cụ thể
Giả sử rằng bạn đã tự xác thực , bạn có thể thêm dữ liệu mới vào bất kỳ bài đăng nào của mình bằng cách sử dụng yêu cầu tương tự như yêu cầu được trình bày trong phần trước, sử dụng POST thay vì GET :
POST yourwebsiteurl.com/wp-json/wp/v2/posts/535/meta?value=newmetadata
Ví dụ: nếu bạn muốn thêm siêu dữ liệu mà bạn có thể sử dụng để tạo đoạn mã phong phú cho công thức, yêu cầu có thể giống như sau:
POST yourwebsiteurl.com/wp-json/wp/v2/posts/535/meta?cookingtime=25