Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On this page

Table of Contents
maxLevel2


Overview

In the 4.25 release (May 2021), we are introducing the API Management - Design First feature that, when combined with the existing API Policy Manager, provides API management capabilities from development to monitoring. You can create APIs in SnapLogic using your own API specifications. 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.

Key Features

  • APIM Console: A new UI that allows you to move 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 specifications. 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 on an OAS 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 an 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 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. 


Panel
bgColor#ebf7e1

Articles in this section

Child pages (Children Display)
alltrue
depth3



Workflow

Prerequisites

  • This The API Management - Design First and the API Policy Manager feature must be enabled. Contact SnapLogic Support to subscribe to the API Management - Design First feature feature.
  • This feature supports the Open API Specification (OAS) 2.0. 
  • You should have a good understanding of the SnapLogic Manager and the SnapLogic expression language.

Support and 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.

  • The Native API Manager and Developer Portal do not support the APIM Design First feature.