Wordpress Connector v1.0
1. General Information
WordPress is a popular open-source content management system (CMS) allowing users to easily create and manage websites. It was initially released in 2003 and has become one of the most widely used platforms for building websites and blogs.
Login into the admin portal of the WordPress site and use the following URL
https://your-wordpress-site.com/wp-admin/index.php and you will be directed to the admin page below.
2. Authentication
WordPress provides a set of APIs to interact with its CMS. WordPress uses HTTP Basic authentication to authenticate requests. To use WordPress APIs for content management on our site we have a create a password for the user from the Admin portal. This password is specifically used for content management through APIs.
a. Password Creation
To create a password for the user, go to Profile in the Users tab in the main menu of the admin portal.
Give a name for the password and click on the Add New Application Password button to create a new password for authenticating requests. This password is used to authenticate requests using basic auth while sending requests to Wordpress using APIs.
3. Connector Actions and Tests
a. Create new post
We can create a new post on WordPress using action Posts: Create Posts (POST). This action needs two parameters Title and Content. We can post the content in text format or HTML with desired formatting. In the example below we are creating a new post using HTML in content. We can also attach a link to the image if we want to attach an image to the post using <img/> of HTML.
Action Name / Method | Media: Create a Media item (POST) | ||
|---|---|---|---|
Action Description | This action is used to upload media to wordpress galary. | ||
Test Case | This test is used to upload media to wordpress galary. | ||
Request Body Name | Parameter | Type | Description (Example) |
| Title required | String |
|
| Content | String |
|
b. Upload Media files to WordPress
We can use action Media: Create a Media item (POST) to upload media to the WordPress gallery. This would upload the media file to the Media Gallery in WordPress. This action only needs one parameter File. In the example below we are uploading an image to a Wordpress gallery.
Action Name / Method | Media: Create a Media item (POST) | ||
|---|---|---|---|
Action Description | This action is used to upload media to wordpress gallery. | ||
Test Case | This test is used to upload media to wordpress gallery. | ||
Request Body Name | Parameter | Type | Description (Example) |
| File required | multipart/form-data |
|
We can see this uploaded media in the Media tab in the admin portal of the WordPress site.
4. Connection Settings and Configuration
Settings Parameters | Value | Description | Required (Y/N) | Default Value |
|---|---|---|---|---|
Connector | Wordpress | Connector Name | Y | Wordpress |
Host Name | Endpoint required for performing CRUD | Y | ||
Authentication | Basic | Type of authentication | Y |
|
