Getting started with Apigee Integration and Apigee proxy Integration targets

Stay organized with collections Save and categorize content based on your preferences.

You're viewing Apigee X documentation.
View Apigee Edge documentation.

This tutorial shows you how to use the Apigee X proxy wizard to create a proxy with an Integration target. The proxy utilizes an API trigger reference from an existing integration to initiate the sequence of steps in the integration.

The steps below describe how to configure the Integration target proxy to run a successful integration when the proxy is called.

Before you begin

  • Confirm your Apigee login credentials and organization details. This information is required to access the Apigee Integration feature and proxy wizard within the Apigee UI.
  • Create and publish an integration with an API Trigger and at least one task.
    • If you have not yet created an integration that uses an API Trigger, follow the steps in Getting Started with Apigee Integration.
    • Note the name of the integration you create, or the existing integration that you would like to use, as this is used in a later step.
  • Confirm your service-GCP_PROJECT_NUMBER service account and verify if the required IAM roles to run/invoke an integration are assigned. For information about the required roles, see IAM roles for integrations.

Create an Apigee Integration target proxy

Do the following to create an Integration target proxy in the Apigee UI:

  1. Go to the Apigee UI and sign in.
  2. Select your organization using the drop-down menu in the upper left corner of the UI.
  3. Click API Proxies in the main view.

    Alternatively, you can select Develop > API Proxies in the left navigation menu.

  4. From the Environment drop-down list, select the environment in which you want to create a new API proxy.
  5. Click Create New.
  6. Select Integration target from the display of proxy types.

    The Create Proxy wizard starts.

  7. In the Proxy details configuration page, provide the following details:
    • Name: Enter a name for the proxy.

      Proxy names can contain alphanumeric characters, dashes, and underscores.

    • Base Path: This is autopopulated based on the proxy name.

      The Base Path is part of the URL used to make requests to your API. Apigee uses the URL to match and route incoming requests to the proper API proxy.

    • Description: (Optional) Enter a brief description of the proxy.

      For example, Proxy test for Apigee Integration.

    • Integration region: Select the region of the integration from the drop-down list.
    • Integration target: Select the name of the integration target from the drop-down list. Note that the integration target list is populated based on the integration region selected.
    • Trigger: Select the API trigger associated with the integration from the drop-down list.
    • Endpoint type: Select Sync.
  8. Click Next.
  9. In the Common policies configuration page, leave the default selections and click Next.
  10. In the Summary page, click Create.

    An Integration target proxy is created successfully.

Deploy the proxy

Perform the following steps to deploy the newly created proxy:

  1. In the Apigee UI, select Develop > API Proxies in the left navigation menu.
  2. Click the recently created proxy.

    By default, the UI displays the Overview tab for that proxy in the Proxy Editor.

  3. Click the Develop tab.
  4. Click Deploy to: ENVIRONMENT_NAME.

    A confirmation dialog for deployment appears.

  5. Enter your Service Account in the confirmation dialog and click Deploy

Test the Integration target proxy

Run the following command from the terminal window to invoke the proxy and trigger the integration:


where YOUR_ENV_GROUP_HOSTNAME is the hostname for an environment group that contains the environment in which your proxy is deployed. See Find the environment group hostname.

For example:

curl -v

To confirm that the integration was triggered by invoking the proxy:

  1. Open the Apigee UI.
  2. Click Develop > Integrations.
  3. Search for or select the name of the integration created in the steps above and click the integration name.
  4. Click Logs.
  5. Verify that an execution log exists for the triggered integration. To see the log details, click the row to expand the execution details.

Update the proxy request payload (Optional)

Use the following steps to update the proxy request payload:

  1. In the Apigee UI, select Develop > API Proxies in the left navigation menu.
  2. Click the recently created proxy.

    By default, the UI displays the Overview tab for that proxy in the Proxy Editor.

  3. Click the Develop tab.
  4. In the Navigator pane, select Set Integration Request under the Policies heading.
  5. Uncomment the <Parameters> block, and enter your parameter details.

    To specify individual parameters, use the <Parameter> element. To specify parameter arrays, use the <ParameterArray> element.

  6. Click Save.

What's next

Explore the Integration designer layout and understand the various integration concepts described in All concepts.