Skip to content
  • Documentation >
  • Apps >
  • Website Building >
  • Yoast

Yoast

With Yoast modules in Ibexa Connect, you can create, update, retrieve, search, and delete:

  • posts

  • categories

  • tags

  • pages

  • custom types

To get started with Yoast, create an account at yoast.com

Connect Yoast to Ibexa Connect

To connect Yoast app, you need to obtain the API Key from your Yoast account and insert it in the Yoast module's create a connection dialog.

  1. Log in to your Yoast account.

  2. Click Company Name > API Key, and copy the API Key to a safe place.

    yoast-1.png

  3. Log in to your Ibexa Connect account, insert a Yoast module scenario and click the Add button next to the Connection field.

    yoast-2.png

  4. In the Connection name field, enter a name for the connection.

  5. In the API Key field, enter the details copied in step 2 and click Save.

You have successfully connected the Yoast app and can now build scenarios.

Posts

You can create, update, retrieve, search, and delete posts using the following modules.

Create an SEO Post

Creates a new SEO post.

For field descriptions, see the Yoast Post API reference.

Update an SEO Post

Updates an existing SEO post.
Post ID Select or map the Post ID whose details you want to update.

For field descriptions, see the Yoast Post API reference.

Get an SEO Post

Retrieves an existing SEO post.
Post ID Select or map the Post ID whose details you want to retrieve.

Search SEO Posts

Searches for SEO posts or lists them all.
Limit Set the maximum number of posts Ibexa Connect will return during one execution cycle. The default value is 10.

Delete an SEO Post

Deletes an existing SEO post.
Post ID Select or map the Post ID you want to delete.

Categories

You can create, update, retrieve, search, and delete categories using the following modules.

Create an SEO Category

Creates a new SEO category.

For field descriptions, see the Yoast Category API reference.

Update an SEO Category

Updates an existing SEO category.
Category ID Select or map the Category ID whose details you want to update.

For field descriptions, see the Yoast Category API reference.

Get an SEO Category

Retrieves an existing SEO category.
Category ID Select or map the Category ID whose details you want to retrieve.

Search SEO Categories

Searches for SEO categories or lists them all.
Limit Set the maximum number of categories Ibexa Connect will return during one execution cycle. The default value is 10.

Delete an SEO Category

Deletes an existing SEO category.
Category ID Select or map the Category ID you want to delete.

Tags

You can create, update, retrieve, search, and delete tags using the following modules.

Create an SEO Tag

Creates a new SEO tag.

For field descriptions, see the Yoast Tag API reference.

Update an SEO Tag

Updates an existing SEO tag.
Tag ID Select or map the Tag ID whose details you want to update.

For field descriptions, see the Yoast Tag API reference.

Get an SEO Tag

Retrieves an existing SEO tag.
Tag ID Select or map the Tag ID whose details you want to retrieve.

Search SEO Tags

Searches for SEO tags or lists them all.
Limit Set the maximum number of tags Ibexa Connect will return during one execution cycle. The default value is 10.

Delete an SEO Tag

Deletes an existing SEO tag.
Tag ID Select or map the Tag ID you want to delete.

Pages

You can create, update, retrieve, search, and delete pages using the following modules.

Create an SEO Page

Creates a new SEO page.

For field descriptions, see the Yoast Pages API reference.

Update an SEO Page

Updates an existing SEO page.
Page ID Select or map the Page ID whose details you want to update.

For field descriptions, see the Yoast Pages API reference.

Get an SEO Page

Retrieves an existing SEO page.
Page ID Select or map the Page ID whose details you want to retrieve.

Search SEO Pages

Searches for SEO pages or lists them all.
Limit Set the maximum number of pages Ibexa Connect will return during one execution cycle. The default value is 10.

Delete an SEO Page

Deletes an existing SEO page.
Page ID Select or map the Page ID you want to delete.

Custom Types

You can retrieve and search SEO custom types using the following modules.

Get an SEO Custom Type

Retrieves an existing SEO custom type.
Type Select the type of SEO custom you want to retrieve.

Search SEO Custom Type

Searches for SEO custom types or lists them all.
Limit Set the maximum number of SEO custom types Ibexa Connect will return during one execution cycle. The default value is 10.

Other

You can call APIs using the following module.

Make an API Call

Performs an arbitrary authorized API call.

Note

For the list of available endpoints, refer to the Yoast API documentation.

URL

Enter a path relative to https://test.malimanek.com/wp-json/wp. For example, /v2/posts.

Method

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of use - List Pages

The following API call returns all pages from your Yoast account.

URL: /v2/pages

Method: GET

Yoast_3.png

The search matches can be found in the module's Output under Bundle > Body.

In our example 10 pages were returned:

Yoast_4.png