Using Application Integration to Create an Apigee Managed API

Version 37

    This document helps you get started with creating managed APIs using the Apigee service in Application Integration.

     

    Use the Apigee service to create proxy API endpoints for REST-based Application Integration processes. These APIs are published to your Apigee account as a managed endpoint. You can enable policies like security and traffic management. Embed these API endpoints within apps  or share them with partners.

     

    Register with Informatica Integration Cloud for Apigee

    The following steps take you through the process of registering with Apigee:

    1. Go to Informatica Integration Cloud for Apigee and contact sales. They will provide you with a registration link.
    2. Enter details and click START YOUR FREE TRIAL.

    3. Follow the instructions in the confirmation email you receive.

     

    Before Creating an Apigee Managed API

     

    Things to do outside of Informatica Intelligent Cloud  Services

    Perform the following tasks to make your integration experience as smooth as possible:

    • Open a browser and log in to your Apigee account. Do this so that you don't need to log in and navigate when you access Apigee  after creating the managed API.
    • Verify that your Apigee account has the privileges to perform the following tasks:
      • Create an API proxy.
      • Deploy an API proxy to one or more environments.
      • Publish an API product.
      • Upload API specifications.

         For more information, see the Apigee documentation on custom roles.

     

    Things to do in Informatica Intelligent Cloud Services

    You need a published Apigee connection in Application Integration before you can use the Apigee service.

    To set up an Apigee connection, perform the following tasks.

    1. Click here to download the GoogleApigeeEdgeConnection ZIP file. Save the file to your system.
    2. In Application Integration, go to Explore > Import and import the ZIP file you downloaded.
      GoogleApigeeEdgeConnection appears within a new project called GoogleApigeeEdge.
    3. Open GoogleApigeeEdgeConnection in Process Designer.
    4. Enter the following connection properties:
      PropertyDescription
      UsernameEmail associated with an Apigee account that has all required permission. For details, please see the Apigee documentation.
      PasswordPassword associated with the Apigee account.
      Edge Identity ZoneThe Edge Identity Zone name you specify when you enable SAML in an Apigee organization. This attribute must be specified when working with a SAML-enabled Apigee organization.


    5. Click Save and then click Publish.

    Creating an Apigee Managed API: Using the Wizard

    Use the New Asset option in the Application Integration to access a wizard that creates Apigee managed APIs.

    1. Log in to Informatica Intelligent Cloud Services and select Application Integration.
    2. Click New.
    3. In the New Asset dialog box, select Services > Apigee > Create.

      The Apigee proxy API creation wizard opens.

     

    Select an Organization and a Service

    Use the Services tab to select the process for which you want to create a managed API.

    Perform the following steps to configure the Services tab:

    1. In the Apigee Org field, enter an existing Apigee organization name.
    2. From the list of available services, select the service for which you want to create a managed API. You must select only one process.
    3. Click Next. The Details tab appears.

     

    Specify Apigee Proxy Details

    Use the Details tab to specify proxy details like the name and path. Application Integration auto populates all fields with information from the process definition file.

    If you want, you can change these values to suit your business need.

    Click Next to go to the Flows tab.

     

    Select an Operation

    Use the Flows tab to select the operations that you want to manage. The Application Integration process might provide multiple operations

    After you select an operation, click Next to go to the Security tab.

     

    Configure Apigee Authorization

    Use the Security tab to configure the authorization that applies when the user invokes the managed API. For now, dpo not configure any Apigee authentication.

    You can choose from the following Authorization options:

    You can also implement the following authorization policies:

    • Impose Quota Per Developer: Restrict the number of API requests that a developer can make. For more information, see Quota policy in the Apigee documentation.
    • Publish API Product: Publish a bundle of resources that provides a specific level of access and functionality for developers. For more information, see What is an API product in the Apigee documentation.
    • Add CORS headers: Add CORS support to the API proxy. For more information, see Adding CORS support to an API proxy in the Apigee documentation.

    Note: The authentication level that you set in Application Integrations still applies.

     

    Click Next to go to the Virtual Hosts tab.

     

    Configure an Endpoint

    Use the Virtual Hosts tab to configure whether you want the managed API to have an HTTP or HTTPS endpoint.

    You can select default, or secure, or both.

    Select default if you want to expose the HTTP versions of the production and test endpoints. Select secure if you want to expose the HTTPS versions of the production and test endpoints.

    After you select a virtual host type, click Next to go to the Build tab.

     

    Specify a Deployment Environment

    Use the Build tab to specify the environments to which you want to deploy the the managed APIs.

    Select at least one deploy environment in the Deploy Environments list.

    You see the prod and test environments that Apigee provides by default. If you configured custom environments in your Apigee account, they also appear.

     

     

    Click Next after you select environments to create the Apigee proxy APIs and deploy them to the environments you selected.

    The Summary tab appears.



    Viewing a Managed API in Apigee

    Click the View API Proxy link in the Summary tab to view the API proxy in Apigee. Apigee opens in a new tab and you see the managed API.

     

    Click the View API Product link in the Summary tab to view the API proxy in Apigee. Apigee opens in a new tab and you see the API product.

    Congratulations! You can now invoke Application Integration APIs using the managed Apigee URLs.

     

    Try This: Samples

    We've created sample assets that you can import into Application Integration. Use these samples to create managed APIs.

    Perform the following steps to import samples, publish processes, and create managed APIs:

    1. Click here to download the Samples_for_Apigee ZIP file.
    2. In Application Integration, go to Explore > Import and import the ZIP file that you downloaded.
      You see that the following assets are imported:

      You see the following projects in the Explore page:
    3. Open the assets in Process Designer, validate them, and then publish them in the following order:
      1. Publish service connectors.
      2. Publish connections.
      3. Publish processes.
    4. Follow the steps outlined in the Creating an Apigee Managed API section.

    For the complete Application Integration documentation, see here.

     

    Troubleshooting

    When you use Application Integration to create an Apigee managed API, you might come across some errors.

    Use the troubleshooting section to find solutions to the errors.

     

    No Connection Found

    Error: Connection_NotFound

    Meaning: Application Integration is unable to find a published connection named “GoogleApigeeEdgeConnection”. This is because the connection either doesn’t exist or is not published.

    Action Required: Ensure that you have correctly configured and published GoogleApigeeEdgeConnection. For details, see the Create and Publish an Apigee Connection section.

     

    Invalid Credentials

    Error: ApigeeAuthentication_ InvalidCredentials

    Meaning: The Apigee connection is published, but with incorrect credentials.

    Action Required: Unpublish the Apigee connection, enter correct credentials, and then re-publish it.

     

    Forbidden

    Error: action_context>_forbidden

    Meaning: You do not have sufficient privileges or permissions for a task.

    For example, if you get an ApigeeCreateAPIproxy_forbidden error, your Apigee account does permission to create an API proxy.

    Action Required: Work with your Apigee account administrator to ensure that you account has the following permission to perform the following tasks:

    • Create an API proxy.

    • Deploy an API proxy to one or more environments.

    • Publish an API product.

    • Upload API specifications.