Contentful

Introduction

Contentful is a content management platform that enables businesses to create, manage, and publish content across multiple channels. The platform provides a flexible and scalable infrastructure for managing content, making it easy to create, manage, and publish digital content such as text, images, videos and more.

You can find more details and the supported operations on Contentful | qibb Catalog.

How to get started with Contentful integration

Before you get started using Contentful integration please make sure that you have the needed permission for the operations.

1. You would need your Access tokens for authentication.

2. Retrieve your Contentful credentials (Token, Space ID, and Environment) from the Settings - API keys page. Note that depending on the Contentful API (respectively node) a different type of token needs to be retrieved. You can generate individual tokens for Content Delivery API, Content Preview API or Content Management API.

   

3. Go to qibb Workflow Editor, open Node Catalog in the right sidebar, and install Contentful node by clicking on the + button.

4. Drag any of the available Contentful nodes from the left sidebar and place them in your flow.

5. Enter your API Keys in the Advanced/Security field of the node and if required your Environment and/or Space ID and start using the integration!

   

For the Content Preview API the API token must be passed as an HTTP authorization header, rather than as a query parameter.

This can be done using the field in Advanced > Security as shown in step 5 above.

Note special cases in the Content Preview API and Content Delivery APIs:

1. To use the ‘Query Entries’ endpoint in v1.0.0 April 2024 (GET /spaces/{space_id}/environments/{environment_id}/entries/) with the query parameter fields.{field_id}[match], the user must also provide the field_id query parameter.

2. The ‘Query’ field can be used independently to search full text. However if the user provides both the ‘Key' field and the ‘Query’ field, they will be combined to form a complete query.

Note a special case in the Content Management API: in the endpoint 'Query tag by visibility' (GET /spaces/{space_id}/environments/{environment_id}/tags), adding a tag name directly as a query parameter is not supported.

Instead the user can use ‘Get a single tag’ (GET /spaces/{space_id}/environments/{environment_id}/tags/{tag_id}).

If the tag_id is unknown, the user can first get it from the response to ‘Get all tags’, which uses the same endpoint as ‘Query tag by visibility’ but without using any query parameters.

Importing flow examples of a node

Once you've successfully installed a node from the qibb catalog, you can easily import example flows that showcase how the nodes can be used. These example flows are directly accessible within the Flow Editor and are designed to guide users with helpful hints, including how to configure mandatory parameters and credentials.

Here's how to import examples:

1. In the top right corner of the Flow Editor, click on the menu icon.

2. Select Import to open the Import Dialog.

3. Click on the Examples tab.

4. Choose an example from the list.

5. Confirm your selection by clicking on the Import button.

By following these steps, you are now ready to make basic API calls using the provided examples. For further exploration of what’s possible, you can find more complex examples in the Flow Catalog.