Overview
Configuration is provided for establishing connections with WordPress via its API v.2. The configuration is used in the REST Connection Manager.
Quick Start
In this task, we will show you step-by-step how to create a connection to a WordPress website using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From drop down menu Configuration select WordPress. You have 3 types of authentication:
Authentication "None"
Choose "None" if the WordPress site doesn't need authentication.
Authentication "Basic/Application"
In this authentication mode you need to provide an administrator's Username and Password
Authentication "OAuth 1.0A"
In this authentication mode you need to specify a Token (via a Wizard) and to save the credentials to a password-protected Token file.
To obtain/specify an access token you need to perform the following 3 steps:
Step A: Provide application ConsumerKey and ConsumerSecret
Step B: Provide administrators Username and Pasword
Step C: Save generated access token to file.
Step 3: After setting up the authentication method, test your connection by clicking Test connection button.
Step 1. Open the right side panel and drag and drop REST Source component. Double click on it and select Rest Wordpress connection, select from available WordPress resources listed in second drop-down menu (Category) and click OK
Step 2. Check resource metadata by selecting Columns
Step 3. If necessary, you can configure the Error Output
Step 4. Connect REST Source component to desired destination component and edit mapping.
Step 1. Drag and drop REST Destination component from the SSIS Toolbox. Double click on it and select Rest WordPress connection, select from available WordPress resources listed in third drop-down menu (Category) , select from available Action listed in second drop-down menu (Create).
Step 2. Connect desired source component to newly created REST Destination component and map columns.
Step 3. If necessary, you can configure the Error Output.
Configuration
Base URL address: http://[host][root].
- None
-
The authentication uses a parameters-based authentication.
The following request parameters will be automatically processed during the authentication process:
- Basic/Application
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- Username:
- Password:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Basic {{=Base64.encode(connection.user.Username + ':' + connection.user.Password)}}
Documentation: https://wordpress.org/plugins/application-passwords/.
- OAuth 1.0a
-
The authentication uses an authorized token.
The authentication has the following user-defined parameters:
- ConsumerKey:
- ConsumerSecret:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
{{=OA1a.getAuthorizationHeader(token, request)}}
Documentation: https://wordpress.org/plugins/rest-api-oauth1/.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/wp-json/wp/v2/posts.The action has the following user-defined parameters:
- search: Limit results to those matching a string.
- author: Limit result set to posts assigned to specific authors.
- author_exclude: Ensure result set excludes posts assigned to specific authors.
- before: Limit response to posts published before a given ISO8601 compliant date.
- after: Limit response to posts published after a given ISO8601 compliant date.
- status: Limit result set to posts assigned one or more statuses. Default: publish
- categories: Limit result set to all items that have the specified term assigned in the categories taxonomy.
- categories_exclude: Limit result set to all items except those that have the specified term assigned in the categories taxonomy.
- tags: Limit result set to all items that have the specified term assigned in the tags taxonomy.
- tags_exclude: Limit result set to all items except those that have the specified term assigned in the tags taxonomy.
- sticky: Limit result set to items that are sticky.
- slug: Limit result set to terms with one or more specific slugs.
- [Create] action
-
Endpoint URL address:
/wp-json/wp/v2/posts.
- [Delete] action
-
Endpoint URL address:
/wp-json/wp/v2/posts/{{=item.id}}.
The resource includes the fields from the post template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/wp-json/wp/v2/pages.The action has the following user-defined parameters:
- search: Limit results to those matching a string.
- author: Limit result set to posts assigned to specific authors.
- author_exclude: Ensure result set excludes posts assigned to specific authors.
- before: Limit response to posts published before a given ISO8601 compliant date.
- after: Limit response to posts published after a given ISO8601 compliant date.
- status: Limit result set to posts assigned one or more statuses. Default: publish
- categories: Limit result set to all items that have the specified term assigned in the categories taxonomy.
- categories_exclude: Limit result set to all items except those that have the specified term assigned in the categories taxonomy.
- parent: Limit result set to items with particular parent IDs.
- menu_order: Limit result set to posts with a specific menu_order value.
- tags_exclude: Limit result set to all items except those that have the specified term assigned in the tags taxonomy.
- sticky: Limit result set to items that are sticky.
- slug: Limit result set to terms with one or more specific slugs.
- [Create] action
-
Endpoint URL address:
/wp-json/wp/v2/pages.
- [Delete] action
-
Endpoint URL address:
/wp-json/wp/v2/pages/{{=item.id}}.
The resource includes the fields from the page template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/wp-json/wp/v2/posts/{{=parameters.post}}/revisions.
The action uses GET method.The action has the following user-defined parameters:
- post: Required. Id of the post.
- [Delete] action
-
Endpoint URL address:
/wp-json/wp/v2/posts/{{=item.id}}/revisions/{{=item.revisionid}}.
The resource includes the fields from the revision template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/wp-json/wp/v2/media.The action has the following user-defined parameters:
- search: Limit results to those matching a string.
- parent: Limit result set to items with particular parent IDs.
- parent_exclude: Limit result set to all items except those of a particular parent ID.
- author: Limit result set to posts assigned to specific authors.
- author_exclude: Ensure result set excludes posts assigned to specific authors.
- before: Limit response to posts published before a given ISO8601 compliant date.
- after: Limit response to posts published after a given ISO8601 compliant date.
- media_type: Limit result set to attachments of a particular media type. One of: image, video, audio, application
- mime_type: Limit result set to attachments of a particular MIME type.
- status: Limit result set to posts assigned one or more statuses. Default: inherit
- slug: Limit result set to terms with one or more specific slugs.
- [Create] action
-
Endpoint URL address:
/wp-json/wp/v2/media.
- [Delete] action
-
Endpoint URL address:
/wp-json/wp/v2/media/{{=item.id}}.
The resource includes the fields from the media template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/wp-json/wp/v2/comments.The action has the following user-defined parameters:
- post: Limit result set to comments assigned to specific post IDs.
- search: Limit results to those matching a string.
- parent: Limit result set to items with particular parent IDs.
- parent_exclude: Limit result set to all items except those of a particular parent ID.
- author: Limit result set to posts assigned to specific authors.
- author_exclude: Ensure result set excludes posts assigned to specific authors.
- author_email: Limit result set to that from a specific author email. Requires authorization.
- before: Limit response to posts published before a given ISO8601 compliant date.
- after: Limit response to posts published after a given ISO8601 compliant date.
- type: Limit result set to comments assigned a specific type. Requires authorization. Default: comment
- status: Limit result set to comments assigned a specific status. Requires authorization. Default: approve
- [Create] action
-
Endpoint URL address:
/wp-json/wp/v2/comments.
- [Delete] action
-
Endpoint URL address:
/wp-json/wp/v2/comments/{{=item.id}}.
The resource includes the fields from the comment template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/wp-json/wp/v2/categories.The action has the following user-defined parameters:
- search: Limit results to those matching a string.
- post: Limit result set to terms assigned to a specific post.
- parent: Limit result set to items with particular parent IDs.
- hide_empty: Whether to hide terms not assigned to any posts.
- slug: Limit result set to terms with one or more specific slugs.
- [Create] action
-
Endpoint URL address:
/wp-json/wp/v2/categories.
- [Delete] action
-
Endpoint URL address:
/wp-json/wp/v2/categories/{{=item.id}}.
The resource includes the fields from the category template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/wp-json/wp/v2/tags.The action has the following user-defined parameters:
- search: Limit results to those matching a string.
- post: Limit result set to terms assigned to a specific post.
- hide_empty: Whether to hide terms not assigned to any posts.
- slug: Limit result set to terms with one or more specific slugs.
- [Create] action
-
Endpoint URL address:
/wp-json/wp/v2/tags.
- [Delete] action
-
Endpoint URL address:
/wp-json/wp/v2/tags/{{=item.id}}.
The resource includes the fields from the tag template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/wp-json/wp/v2/users.The action has the following user-defined parameters:
- search: Limit results to those matching a string.
- roles: Limit result set to users matching at least one specific role provided. Accepts csv list or single role.
- slug: Limit result set to terms with one or more specific slugs.
- [Create] action
-
Endpoint URL address:
/wp-json/wp/v2/users.
- [Delete] action
-
Endpoint URL address:
/wp-json/wp/v2/users/{{=item.id}}.
The resource includes the fields from the user template.
- [Read] action
-
The result is extracted from:{{=response}}.
The action uses GET method.
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}} -
per_page:
{{=parameters.batchSize}} -
context:
view -
params:
{{=parameters}}
-
page:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Delete] action
-
The action uses DELETE method.The following request parameters will be automatically processed:
-
id:
-
force:
false
-
id:
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 4000 )
- Integer
Data type: DT_I4
- Boolean
Data type: DT_BOOL
- DateTime
Data type: DT_DBTIMESTAMP
- ShortRendered
Data type: DT_WSTR ( length 1000 ) The gathered value is processed with
{{=value.rendered}}expression.- LongRendered
Data type: DT_NTEXT The gathered value is processed with
{{=value.rendered}}expression.- MediaDetails
Field components:
-
Uses template:
Integer. - Contains the following components: width, height, file.
-
Uses template:
- AvatarDetails
Field components:
-
Uses template:
ShortText. - Contains the following components: 24, 48, 96.
-
Uses template:
- user
Field components:
-
Uses template:
Integer. - Contains the following components: id, username, name, first_name, last_name, email, url, description, link, nickname, slug, registered_date, roles, password, capabilities, extra_capabilities, avatar_urls.
-
Uses template:
- comment
Field components:
-
Uses template:
Integer. - Contains the following components: id, author, author_email, author_ip, author_name, author_url, author_user_agent, content, date, date_gmt, karma, link, parent, post, status, type, author_avatar_urls.
-
Uses template:
- status
Field components:
-
Uses template:
ShortText. - Contains the following components: private, protected, public, queryable, show_in_list, name, slug.
-
Uses template:
- taxonomy
Template: type. Field components:
-
Uses template:
Boolean. - Contains the following components: show_cloud, types.
-
Uses template:
- category
Template: tag. Field components:
-
Uses template:
Integer. - Contains the following components: parent.
-
Uses template:
- tag
Field components:
-
Uses template:
Integer. - Contains the following components: id, count, description, link, name, slug, taxonomy.
-
Uses template:
- type
Field components:
-
Uses template:
ShortText. - Contains the following components: capabilities, description, hierarchical, labels, name, slug.
-
Uses template:
- media
Field components:
-
Uses template:
DateTime. - Contains the following components: date, date_gmt, guid, id, modified, modified_gmt, password, slug, status, type, title, author, comment_status, ping_status, alt_text, caption, description, media_type, mime_type, media_details, post, source_url.
-
Uses template:
- revision
Field components:
-
Uses template:
DateTime. - Contains the following components: date, date_gmt, guid, id, modified, modified_gmt, slug, title, content, author, excerpt, parent.
-
Uses template:
- commonPostPage
Field components:
-
Uses template:
DateTime. - Contains the following components: date, date_gmt, guid, id, link, modified, modified_gmt, password, slug, status, type, title, content, author, excerpt, featured_media, comment_status, ping_status.
-
Uses template:
- post
Template: commonPostPage. Field components:
-
Uses template:
ShortText. - Contains the following components: format, sticky, categories, tags.
-
Uses template:
- page
Template: commonPostPage. Field components:
-
Uses template:
Integer. - Contains the following components: parent, menu_order, template.
-
Uses template:
Knowledge Base
- Where can I find the documentation for the WordPress Connection?
- How to enable OAuth authentication in WordPress?
What's New
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.