Generating Pipeline APIs and Managing them in Apigee Edge

In this article

Overview

SnapLogic supports REST API workflow integration with Apigee Edge, a popular platform for managing API services. You can export Triggered Task and Ultra Task pipelines in your SnapLogic environment and manage them as APIs in the Apigee Management Console. API Services provided by Apigee Edge include:

  • Specification Publishing
  • API Proxy/Protocol Translation
  • Throttling/Traffic Shaping
  • Market Place
  • Developer Portal
  • Analytics

You can view the generated API that conforms with the Open API specifications in Swagger

To understand more about Apigee Edge and how to use its API platform, read their documentation

Prerequisites 

  • You are an advanced user of SnapLogic and Apigee Edge
  • Your org is using SnapLogic JCC (4.13)
  • You have Apigee account user credentials
  • You have defined Ultra Tasks or Triggered Tasks in your SnapLogic pipelines


  • The default timeout value of the Apigee Router message processor is 57 seconds. Hence, SnapLogic pipelines running longer than the default value of 57 seconds return a Gateway Timeout error. To avoid this limitation, increase the timeout value of the virtual hosts running the Apigee API Proxy to 15 minutes and 10 seconds.  
  • Apigee integration does not work on SnapLogic orgs with enhanced account encryption enabled. 

Using Pipeline Tasks to Generate APIs via Apigee

Integration Workflow in SnapLogic

Steps

  1. In the SnapLogic Manager tab, browse to the project folder that has the pipelines you want to use for the Apigee API integration.

  2. In the Accounts tab, launch the Create Account screen by clicking  and selecting REST > REST Basic Auth Account.

    The REST Basic Auth Account is shareable and reusable across the shared projects per org.  

  3. In Create Account, enter an account name for Apigee in Label, along with your Apigee account user credentials – Username and Password.


  4. Click the project folder and select API Proxy to start building your Apigee proxy.


  5. Perform the following steps in the Create Apigee API Proxy wizard:






    1. Apigee supports only letters, numbers, dashes (-) and underscore ( _ ) for the Proxy Name

      Recreating a proxy triggers the following alert:

      If you opt to revise a proxy, then the current proxy is simply overwritten.

    2. Enable Add CORS Headers for the "try out" feature to work in Swagger Online Editor.



    3. Clicking Build & Deploy displays "Building..." for some time while the API is generating. 

    4. Click Download OpenAPI File to download the zip file containing all the .yaml files. Click Yes to publish the API product (and read the next step). Else, click No and view the downloaded .yaml file in any text editor like Swagger.

  6. (Optional) If you choose to create a product in Apigee, provide the required details, and click Publish

    Apigee supports only letters, numbers, dashes (-) and underscore ( _ ) for the Product Name

The dialog displays a "Publishing..." message for a few minutes, then closes itself. You can now check your Apigee account to manage the API proxy product. 

Troubleshooting 

  • In SnapLogic, view the pipeline task history for pointers on any task related issues.
  • In Apigee Edge, use the Trace tool to investigate any proxy issues.

See Also