About the Wordpress category

anon99371720 · December 11, 2023, 8:54am

Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation:

Connector package documentation

1. Setting up HTTP Client Wordpress

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
Select Wordpress HTTP Client as PlatForm and click the next step.
Fill in the Base URI with https://{{your_wordpress_domain}}/wp-json/wp/v2
Fill in the Username with your Wordpress username.
Fill in the Password with your Wordpress password.
You can optionally enable the logging of requests to get the authentication log.
Click the next step, fill in the name of the HTTP Client and finally you can save the HTTP Client to use

2. Subscribing to Entities from Wordpress

2.1 Steps

Go to Connections → Incoming → create a new incoming configuration and select “Wordpress Subscriber” as the subscriber.
Select the entity you want to subscribe to from Wordpress.
Add any request parameters needed to subscribe to the entity.
Select the Wordpress HTTP Client to use.
You can optionally add a transformer to transform the request parameters into something you will request from Wordpress.
You can also optionally enable pagination to allow Alumio to fetch paginated entities.

2.2 General Concept

We follow Wordpress documentation on building this connector, so you can easily use the connector based on Wordpress API Reference.

Entity

The entity you want to subscribe to Wordpress. Please refer to the entities from the Wordpress API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on the Wordpress API Reference.

Please look at the example below on how to fill the path field when subscribing to the Posts entity.

Based on the documentation, we can query a single post by setting the post ID inside the path key in the Request Parameters.

Alumio will then make a request to Wordpress with the URL /posts/{id}

HTTP Client

The HTTP Client configuration you will use to access Wordpress.

3. Publishing Entity to Wordpress

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select “Wordpress Publisher” as the publisher.
Select the Method that you want the publisher to perform with the data.
Select the Wordpress entity you want the data to be published.
You can optionally add any query data to the request on the key query.
You can optionally add any payload data to the request on the key payload.
Select the HTTP Client to use.

3.2 General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer.

Method

Currently, we support the HTTP Post and Delete method on submitting data to Wordpress.

Entity

We support publishing to most Wordpress endpoints.
Please refer to Wordpress API Reference page.

For example, we want to add a new Post. Please select “post” as the Method.
with this payload:

{
    "title": "Draft Lathif December 8",
    "status": "draft"
}

Alumio will send an API request to Wordpress with the URL /posts, and here is the response example: