Skip to end of banner
Go to start of banner

SnapLogic API Management

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 110 Next »

In this article

Overview

You can create APIs from your own specifications or from your SnapLogic Pipelines and Assets. To make your APIs available to users outside SnapLogic, you can publish those APIs in a Developer Portal that is customized with your own branding. You can also create proxies to allow you to integrate with third-party APIs.

Key Features and Components

SnapLogic provides API Management features and components to help you develop APIs, manage their lifecycles, and monitor their performance.

Features include:

  • Support for Design First. API Management supports the creation of APIs from the Open API Specification (OAS) 2.0. You can design an API based on your specification, then upload a file or reference a URL containing your specification.

  • API Lifecycle Management. You can manage the entire lifecycle of an API or API version from creation to publication to deprecation to retirement.

  • Multiple API Versions. You can modify the initial specification of your API, then create and publish a new version from the modified specification.

Components include:

  • API Manager. The console where you manage your APIs.

  • Portal Manager. The console where you set up and manage your custom Developer Portal.

  • Developer Portal. The custom site where you publish your APIs for consumption. In this site, API consumers can search and browse through your API Catalog and try out your APIs. Each API provides basic documentation and its specification.

  • Subscription Manager. The console where you can approve and manage subscriptions to published APIs.

  • API Policies. A suite of security policies that handle authorization, authentication, and traffic control to manage access to your APIs. You can apply these policies at various levels, such as the Org, the API, the API version, the shared folder of the Project Space, and Project folders. Org Administrators can define permissions at very level of the hierarchy; API developers can set permissions on their own API versions.

  • API Dashboard. The API tab in Dashboard where you can view the usage and traffic metrics of your APIs. You can track the popularity of an API or analyze target and response errors to understand how to enhance the API consumer experience.


API Management Architecture

Prerequisites

  • The API Management feature must be enabled for your Org. Contact SnapLogic Support to subscribe to this feature.

  • Your API specifications must be based on Open API Specification (OAS) 2.0. 

  • You must have a good understanding of the SnapLogic Manager and the SnapLogic expression language.


API Manager - Design First Workflow

When you import or reference an API specification to the new /apim space, a new API asset is created. The new API comprises a Pipeline that is the scaffolding for the API and the Task used to call it. You can then create versions, add API policies, set permissions, and modify the underlying SnapLogic assets to build the business logic for your API. You can find instructions for this workflow here: Creating the API using Design First


Create New API from existing Pipelines and Tasks

You can also create an API in the API Manager Console by referencing existing Projects in Manager. This functionality enables you, as a Pipeline designer, to complete your Pipeline building activity first. The advantage of this approach is taking advantage of your existing SnapLogic infrastructure. You can segment the design and testing activities as you build Pipelines and creates Triggered Tasks from them individually testing and vetting them for production. Once your Pipeline assets are production ready, you can create APIs in the API creation dialog windows. You can find instructions for this workflow here: Creating the API from Existing Project Assets


Limitations

  • For Cloudplex users, you must set up a load balancer for the API Policy Manager to work. You must use the load balancer URL in your Triggered and Ultra Task endpoints.

  • Only one API policy of a type is applicable at a level in the hierarchy. 

  • When you open a Task in an API version, you cannot change it to Scheduled (not visible). Also, the Task dialog window displays the Snaplex, but it cannot be modified.

  • In Designer, when you open a Pipeline in an API version, the Snaplex selector in the Edit Pipeline dialog window only shows the Snaplex instances from the global shared folder.

  • In Designer, the asset or account selectors in the Snap dialog window opened from a Pipeline in the API Management - /apim space, only shows assets from the global shared folder, in addition to those in the current version.

  • You can change a Snaplex for an API Version if it is unpublished. However, clicking Edit Details from the API > Versions page displays the Server field for selecting another Snaplex, but the field is disabled if the Snaplex is down.


Server Configuration

If you need a new Cloudplex server for your environment, contact support at snaplogic.com with the request to set up a Cloudplex FeedMaster node. SnapLogic Support will add a Load Balancer to the provisioned new (or existing) Snaplex. Once the Load Balancer is set up, your Org admin must update the Load Balancer information URL in Update Snaplex > Settings.

Refer to this page for more information: Updating a Snaplex 


See Also


  • No labels