WordPress (original) (raw)

Skip to main content

The WordPress connector lets you perform insert, delete, update, and read operations on WordPress.

Before you begin

Before using the WordPress connector, do the following tasks:

Configure the connector

A connection is specific to a data source. It means that if you have many data sources, you must create a separate connection for each data source. To create a connection, do the following:

  1. In the Cloud console, go to the Integration Connectors > Connections page and then select or create a Google Cloud project.
    Go to the Connections page
  2. Click + CREATE NEW to open the Create Connection page.
  3. In the Location section, choose the location for the connection.
    1. Region: Select a location from the drop-down list.
      For the list of all the supported regions, see Locations.
    2. Click NEXT.
  4. In the Connection Details section, complete the following:
    1. Connector: Select WordPress from the drop down list of available Connectors.
    2. Connector version: Select the Connector version from the drop down list of available versions.
    3. In the Connection Name field, enter a name for the Connection instance.
      Connection names must meet the following criteria:
      • Connection names can use letters, numbers, or hyphens.
      • Letters must be lower-case.
      • Connection names must begin with a letter and end with a letter or number.
      • Connection names cannot exceed 49 characters.
    4. Optionally, enter a Description for the connection instance.
    5. Optionally, enable Cloud logging, and then select a log level. By default, the log level is set to Error.
    6. Service Account: Select a service account that has the required roles.
    7. Optionally, configure the Connection node settings:
      • Minimum number of nodes: Enter the minimum number of connection nodes.
      • Maximum number of nodes: Enter the maximum number of connection nodes.
        A node is a unit (or replica) of a connection that processes transactions. More nodes are required to process more transactions for a connection and conversely, fewer nodes are required to process fewer transactions. To understand how the nodes affect your connector pricing, see Pricing for connection nodes. If you don't enter any values, by default the minimum nodes are set to 2 (for better availability) and the maximum nodes are set to 50.
    8. (Optional) In the Advanced settings section, select the Use proxy checkbox to configure a proxy server for the connection and configure the following values:
      • Proxy Auth Scheme: Select the authentication type to authenticate with the proxy server. The following authentication types are supported:
        * Basic: Basic HTTP authentication.
        * Digest: Digest HTTP authentication.
      • Proxy User: A user name to be used to authenticate with the proxy server.
      • Proxy Password: The Secret manager secret of the user's password.
      • Proxy SSL Type: The SSL type to use when connecting to the proxy server. The following authentication types are supported:
        * Auto: Default setting. If the URL is an HTTPS URL, then the Tunnel option is used. If the URL is an HTTP URL, then the NEVER option is used.
        * Always: The connection is always SSL enabled.
        * Never: The connection is not SSL enabled.
        * Tunnel: The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.
      • In the Proxy Server section, enter details of the proxy server.
        1. Click + Add destination.
        2. Select a Destination Type.
        * Host address: Specify the hostname or IP address of the destination.
        If you want to establish a private connection to your backend system, do the following:
        * Create a PSC service attachment.
        * Create an endpoint attachment and then enter the details of the endpoint attachment in the Host address field.
    9. Optionally, click + ADD LABEL to add a label to the Connection in the form of a key/value pair.
    10. Click NEXT.
  5. In the Destinations section, enter details of the remote host (backend system) you want to connect to.
    1. Destination Type: Select a Destination Type.
      • To specify the destination hostname or IP address, select Host address and enter the address in the host 1 field.
      • To establish a private connection, select Endpoint attachment. In theEndpoint Attachment list, select the endpoint attachment created for your backend system.
        If you want to establish a public connection to your backend systems with additional security, you can consider configuring static outbound IP addresses for your connections, and then configure your firewall rules to allowlist only the specific static IP addresses.
        To enter additional destinations, click +ADD DESTINATION.
    2. Click NEXT.
  6. In the Authentication section, enter the authentication details.
    1. Select an Authentication type and enter the relevant details.
      The following authentication types are supported by the WordPress connection:
      • Username and password
      • OAuth 2.0 - Authorization code

To understand how to configure these authentication types, see Configure authentication.
2. Click NEXT. 7. Review: Review your connection and authentication details. 8. Click Create.

Configure authentication

Enter the details based on the authentication you want to use.

System limitations

The Wordpress connector can process 4 transactions per second per node, and throttles any transactions beyond this limit. By default, Integration Connectors allocates 2 nodes (for better availability) for a connection.

For information on the limits applicable to Integration Connectors, see Limits.

Use the Wordpress connection in an integration

After you create the connection, it becomes available in both Apigee Integration and Application Integration. You can use the connection in an integration through the Connectors task.

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects of the connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

Entity operation examples

Example - List all the posts

This example lists all the posts in the Posts entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select Posts from the Entity list.
  3. Select the List operation, and then clickDone.

Example - Get a post

This example fetches a post from the Posts entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select Posts from the Entity list.
  3. Select the Get operation, and then clickDone.
  4. In the Task Input section of the Connectors task, click entityId and then enter 123 in the Default Value field.
    Here, 123 is an unique identifier for the resource Posts entity.

Example - Delete a post

This example deletes a post from the Posts entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select Posts from the Entity list.
  3. Select the Delete operation, and then clickDone.
  4. In the Task Input section of the Connectors task, click entityId and then enter 123 in the Default Value field.
    Alternately, if the entity has composite primary keys instead of specifying the entityId, you can set the filterClause. For example, Id='123'.

Example - Create a post

This example creates a post in the Posts entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select Posts from the Entity list.
  3. Select the Create operation, and then click Done.
  4. In the Task Input section of the Connectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:
    {
    "Title": "Post from AIP",
    "Content": "Content added from AIP"
    }

If the integration is successful, the connector task's connectorOutputPayload field will have the response of the create operation.

{ "Id": 1010 }

Example - Update a post

This example updates a post in the Posts entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select Posts from the Entity list.
  3. Select the Update operation, and then click Done.
  4. In the Task Input section of the Connectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:
    {
    "Title": "Update abc"
    }
  5. In the Task Input section of the Connectors task, click entityId and then enter 1010 in the Default Value field.

If the integration is successful, the connector task's connectorOutputPayload field will have the response of the update operation.

{ "Id": 1010 }

Create connections using Terraform

You can use the Terraform resource to create a new connection.

To learn how to apply or remove a Terraform configuration, seeBasic Terraform commands.

To view a sample terraform template for connection creation, see sample template.

When creating this connection by using Terraform, you must set the following variables in your Terraform configuration file:

Parameter name Data type Required Description
proxy_enabled BOOLEAN False Configures a proxy server for the connection.
proxy_auth_scheme ENUM False The authentication type to use to authenticate to the ProxyServer proxy. Supported values are: BASIC, DIGEST, NONE
proxy_user STRING False A user name to be used to authenticate to the ProxyServer proxy.
proxy_password SECRET False A password to be used to authenticate to the ProxyServer proxy.
proxy_ssltype ENUM False The SSL type to use when connecting to the ProxyServer proxy. Supported values are: AUTO, ALWAYS, NEVER, TUNNEL

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-06-18 UTC.