SnapLogic API Management

In this article

Overview

When combined with the existing API Policy Manager, the API Manager and Portal Manager provide capabilities from API development, lifecycle management, and dashboard monitoring. You can create APIs in SnapLogic using your own API specifications, or build them from your Pipelines and SnapLogic assets. 

You can also publish APIs to the Developer portal, which you can customize with your own branding. Users external to SnapLogic can explore the APIs you build in the SnapLogic platform in the Developer Portal's API Catalog.

Key Features

  • APIM Console: A new UI that allows you to navigate easily through the API development workflow. The API Manager console provides built-in management capabilities for your APIs and a space where developers can create and test their APIs.
  • Design First: The /apim space supports the creation of APIs from the Open API Specification (OAS) 2.0. You can design an API based on your specification and then upload a file of it or reference a URL with the specification.
  • Versioning: The ability to create multiple versions of an API based using an OAS 2.0 specification. You can modify the specification for your initial API, then create new versions from those modified specification versions.
  • Hierarchy Permissions: A comprehensive set of permission types that provides Org admins the ability to define permissions at every level of the hierarchy. As an API developer, you can set permissions on your versions.
  • Suite of API Policies: The Manage API Policy wizard that enables you to enable various authorization, authentication, and traffic control policies at the /apim space, API, and Version levels.
  • API Lifecycle Management: The capability of publishing APIs to the developer portal. All the actions important to the lifecycle of an API are available, such as unpublishing, re-publishing, deprecating, and retiring your APIs.
  • Manage your API Catalog: The Portal Manager is a new console for managing the developer portal for your Org. You can now customize the new Developer Portal with your own branding and URL suffix. The Portal Manager also enables you to view API status on the API Catalog.
  • Developer Portal: A page for non-SnapLogic users to explore your APIs. API consumers can search and browse through APIs. Each API provides basic documentation and its specification.
  • API Dashboard: The dashboard displays usage and traffic metrics of your APIs. As an Org admin or Pipeline Designer, 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 - Design First and the API Policy Manager features must be enabled. Contact SnapLogic Support to subscribe to the  feature.
  • This API Management - Design First feature supports the Open API Specification (OAS) 2.0. 
  • You should 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