A Beginner's Guide to the WordPress REST API

A Beginner’s Guide to the WordPress REST API

A Beginner’s Guide to the WordPress REST API

Unless you’ve been building WordPress sites for many years, the probabilities are that you’re uncertain what the WordPress Rest API is.

Man or woman the use of a pc out of doors to access the wordpress REST API
Although a extraordinarily new feature, the WordPress Rest API has converted what WordPress as a platform is able to because it now makes it easy for builders to connect WordPress with different software and web sites.

Grow Your Business With HubSpot’s Tools for WordPress Websites
In this manual, we’ll explain what APIs are and what REST is. Then, we’ll explore how builders use the WordPress REST API to skip its obstacles. Click any of the bounce links underneath to bypass to that segment:

What is the WordPress REST API?
How to Use the WordPress REST API
WordPress REST API Examples
When to Use the WordPress Rest API

What is the WordPress REST API?
The WordPress REST API is an interface that lets in outside programs to get admission to the statistics and capability of the WordPress CMS. This tool we could builders integrate WordPress into 1/3-birthday celebration web applications and web sites without needing to log into WordPress.

If you’re new to APIs and REST, that definition won’t make complete experience just yet. So allow’s briefly cowl what APIs and REST APIs are and why they count number right here.

What is an API?
An software programming interface, or API, is part of a piece of software program that allows external packages to communicate with it. An API exposes a part of an utility’s facts and functionality, enabling integration by means of 1/3-birthday celebration programs.

For example, say you wanted to display a YouTube video on your internet site. Since the video is owned by using YouTube and saved on a YouTube server, you request the video thru YouTube’s API. After the API receives and approves your request, it sends the video lower back to you, and you can embed it as desired.

Or, say you need your application to upload a video to YouTube — YouTube’s API lets you do that as nicely. But this time, you make a distinctive request asking to add your content material. If the API approves, then the video uploads without requiring you to log into a YouTube consumer account.

APIs make today’s software atmosphere feasible. Through APIs, disparate software program packages can integrate and share data in an automated and standardized way.

APIs are how developers can connect a internet site to Google Maps and consist of live maps on their websites. Thus, they don’t need to begin from scratch, code up a map and gather the huge quantity of records required. Instead, via building on the present framework, existence’s simpler for everyone.

Whether it’s your automation software program scheduling your social media posts or the weather app in your phone, most of your preferred apps hire APIs in some way.

What is a REST API?
When we’re talking approximately APIs on the net, we’re usually speakme about a form of API known as REST API. REST, quick for Representational State Transfer, is a fixed of suggestions for constructing web APIs. APIs that follow those guidelines are REST APIs (or RESTful APIs).

Check out our dedicated REST API post for a more specific take a look at REST APIs. But, for now, we can in short summarize the 5 necessities of REST APIs on account that these govern how the WordPress REST API works. These necessities are:

Client-server separation: The software hosting the API (referred to as the “server”) and the application using the API (known as the “purchaser”) are kept as separate structures. They may also only communicate through a request from the client followed with the aid of a response from the server.
Uniform interface: All requests and responses ought to comply with a common protocol. In maximum cases, REST APIs use the Hypertext Transfer Protocol (HTTP) to communicate over the internet.
Stateless: All interactions with an API are impartial of each different. Every request and response should include all information important to complete the interplay with out referencing preceding requests/responses.
Layered device: Rarely are the purchaser and server directly connected over a community. Usually, proxy servers exist among them to deal with site visitors, overall performance, and safety. RESTful requests and responses have to usually be formatted the identical, irrespective of what number of layers exist between customer and server.
Cacheable: If a customer requests resources (i.E., records) from the server, the server ought to suggest whether the supplied useful resource may be cached by means of the client and for the way long.
These constraints standardize how net programs speak to every other. They make certain that any interplay with any REST API follows a comparable procedure. It also maintains the two applications unbiased, such that adjustments or improvements to both utility will not affect communique between them.

What does the WordPress REST API do?
The WordPress REST API is, because the name implies, a REST API, so it operates along the hints listed above.

Specifically, the WordPress REST API exposes WordPress’s internal workings to out of doors developers, which makes it possible to integrate WordPress with other applications in severa ways. And due to the fact REST is so common in net APIs, the WordPress REST API is incredibly clean for any developer to research and use.

Originally evolved as an open-supply WordPress plugin, the WordPress REST API became added to WordPress middle in version 4.7, launched in 2016.

This become a widespread step for WordPress, effectively turning it right into a software program platform. Now, developers can construct with WordPress without having to construct inside it.

For instance, you would possibly need to construct an internet utility from scratch however harness WordPress’s content material management and article drafting capabilities. With the WordPress REST API, you can fetch put up content out of your WordPress account and put up it on your custom internet software. Or, you may join WordPress to a cell app you’re constructing with the REST API. You’re possibly familiar with the Gutenberg block editor — that is a real instance of an internet app that uses the WordPress REST API to retrieve and adjust content in the WordPress database.

The WordPress REST API also unlocks powerful flexibility for developers. Without it, builders could want to adjust WordPress with PHP, WordPress’s server-facet scripting language. Now, developers can software outside the restrictions of WordPress and paintings in a distinctive language, which include the the front-end programming language JavaScript.

Lastly, be aware that the WordPress REST API is considered one of several APIs maintained by WordPress.

A listing of wordpress APIsImage Source

These different WordPress APIs particularly exist to allow plugins and topics to interact with WordPress middle.

How to Use the WordPress REST API
Before we test with posting and receiving WordPress records, let’s assessment a few key phrases to recognise before the usage of the WordPress REST API.

WordPress REST API Terms
First off, a request is what you send to the WordPress REST API. It specifies what aid inside the WordPress database you need to target and what you need to do with it.

A reaction is what the API sends returned after your request. It includes any statistics you requested, in addition to a affirmation if the request become successful or an errors message.

A course is a URL used to discover a resource through the WordPress API, like a put up, page, metadata, user, or other records kind. For instance, the direction “http://yourwebsite.Com/wp-json/wp/v2/pages” is used to get right of entry to the pages on a WordPress website.

Routes are used in endpoints to get entry to or regulate facts thru the API. An endpoint combines a direction with a command referred to as an HTTP approach. The four HTTP strategies you’ll in all likelihood use most often are:

GET: This approach retrieves information from the server.
POST: This method provides facts to the server.
PUT: This method edits data already on the server.
DELETE: This approach removes statistics from the server.
For instance, an endpoint that retrieves all WordPress pages from yourwebsite.Com could appear to be this:

GET http://yourwebsite.Com/wp-json/wp/v2/pages
An endpoint that provides a new web page to yourwebsite.Com seems like this:

POST http://yourwebsite.Com/wp-json/wp/v2/pages
The WordPress Developer Reference lists all of the REST API’s routes and endpoints, which will let you get right of entry to and manage honestly anything to your WordPress web page. Most, if no longer all, of your interactions with the WordPress API, will make use of those endpoints.

Depending on how you operate the REST API, you could also need to provide authentication to make requests. For many requests, WordPress wishes to verify who you’re first. By default, you could get right of entry to most public content for your internet site with the API without authentication, at the same time as gaining access to private information calls for authentication.

Make a Request to the WordPress REST API
With the fundamental terminology down, we now recognise sufficient to send simple requests to the REST API. We don’t suggest trying out the REST API to your live website — alternatively, installation a test internet site on a server or locally to make requests.

The handiest manner to make manual API requests is through the command-line interface (CLI), a program with that you write textual content-primarily based instructions to your computer’s working system. On Windows, the default CLI program is Command Prompt. On macOS, it’s known as Terminal.

To talk with an API from the command line, you could use cURL, a free tool to make HTTP requests (among many other varieties of requests). You might also attempt WP-CLI, a unfastened command-line interface especially for WordPress that lets you engage with your WordPress internet site with out the use of your browser.

Using SSH, use cURL or WP-CLI to get right of entry to your remote or local test site. If precipitated, input your credentials for authentication.

Once you’ve accessed your check website, you may begin sending requests. The base path to your API requests is:

http://yourwebsite.Com/wp-json/
wherein “yourwebsite.Com” is your area. You’ll add subdirectories to the stop of this URL to request particular data.

Let’s begin with our previous example, getting all pages from your WordPress web site. The endpoint for this action is:

GET http://yourwebsite.Com/wp-json/wp/v2/pages
If rather, you want to retrieve a selected web page, you may do this with the aid of adding the page identity to the end of the route:

GET http://yourwebsite.Com/wp-json/wp/v2/pages/
Where is the numeric identity of the page.

Next, let’s experiment with the POST technique. We can use POST to add a new page to a internet site with the following syntax:

POST http://yourwebsite.Com/wp-json/wp-json/wp/v2/pages
This provides a clean page for your website, which you could populate with content.

What if you need to get data about a particular person for your WordPress account? This is likewise viable with a simple request:

GET http://yourwebsite.Com/wp-json/wp/v2/customers/
Where is the numeric identification of the user.

We’re most effective scratching the floor of what’s viable here — to make the most of the WordPress REST API, your requests can be lots extra complicated. However, in case you’re just getting the cling of WordPress APIs and APIs in trendy, it’s well worth working towards more truthful requests to gain a solid draw close of the fundamentals.

WordPress REST API Examples
We’ve seen how developers can request records and make adjustments via WordPress’s REST API — now, let’s test out some examples of what this API seems like in motion.

Gutenberg
The WordPress Gutenberg editor application implements the WordPress REST API to access pages and publish records. It fetches web page and publish records, inclusive of textual content and media, from the WordPress database and permits you to location your content material with blocks — a simple example of the API at paintings.

Product page for gutenberg, a wordpress rest API instance

Image Source

AppPresser
AppPresser shall we users create iOS and Android cell apps that combine with WordPress web sites. It calls the WordPress REST API to retrieve content from WordPress and to adjust database contents as dictated by your cell app.

Product page for apppresser, a wordpress relaxation API example

Image Source

Wired
Shortly after the WordPress REST API turned into released as part of WordPress core, famous generation booklet Wired used the API to make a synced reproduction in their major website for checking out. The test web page changed to in shape every time the primary internet site updated its content.

Product web page for wired.Com, a wordpress relaxation API instance

Image Source

Event Espresso
Event Espresso is an occasion management and ticketing plugin for WordPress that makes use of the WordPress REST API. With an upload-on, web site proprietors could make event records to be had to builders, which outside apps and web sites can use.

Product page for event espresso, a wordpress rest API example

Image Source

When to Use the WordPress Rest API
The WordPress REST API is tremendous for 2 prominent instances.

First, it’s helpful to combine WordPress into an utility or website you’re the usage of (that isn’t itself made with WordPress).

Second, you could create issues and plugins in PHP, JavaScript, or any language of preference, then use the WordPress Rest API to get admission to the data needed.

However, there are cases where this API isn’t necessary. Namely, if you need to broaden a topic or plugin with PHP, strive leveraging WordPress’s other APIs, just like the Plugin API and Theme Customization API.

Website owners can also accomplish a whole lot with a appropriate WordPress subject and significant customization.

In quick, the WordPress REST API isn’t usually the right answer, but when it is, it’s powerful. The WordPress API documentation places it properly: “If you want a established, extensible, and simple way to get statistics inside and outside of WordPress, you probably need to apply the REST API.”

The WordPress REST API: Build with WordPress, outdoor of WordPress.
To stay up-to-date with how the WordPress CMS is growing and adapting, you’ll want to recognize at least the basics of its REST API. The WordPress REST API acts as a gateway to the extra utility atmosphere. Now, exclusive software can leverage WordPress generation outside of the tool.

If you’re not a developer, it nevertheless enables to know how the REST API works, just in case you decide to integrate WordPress with your tools in any way. With some more understanding, you can diagnose troubles, collaborate with devs, and maybe someday make custom integrations yourself.