In this article
| Table of Contents | ||
|---|---|---|
|
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 from your own API specifications , or build them from your SnapLogic Pipelines and SnapLogic assets. You can also publish APIs to the Developer portal, which you can customize 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. Users external to SnapLogic can explore the APIs you build in the SnapLogic platform in the Developer Portal's API Catalog.
Key Features
You can also create proxies to allow you to integrate with third-party APIs.
Your API serves as a container for SnapLogic Assets:
Pipelines. A representation of the API specification and its child Pipelines, if any. Provides the scaffolding of the API’s implementation in the SnapLogic platform.
Tasks. The URI endpoints that are used to trigger Pipeline execution.
Files. The specification file and other files that are associated with the API.
Accounts. Accounts that are used by Pipelines in the API.
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) 3.0 or 2.0. You can design an API based on your specification
and, then upload a file
of itor reference a URL
with the specification.Versioning: The ability to create multiple versions of an API based using an OAS 2.0 specificationcontaining your specification. Both JSON and YAML file formats are supported.
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
forof your
initialAPI, then create and publish a new
versionsversion from
thosethe 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
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. Users with a SnapLogic platform login can open the Developer Portal with one click from the Resources section of the Apps menu:
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
sharedfolder of the Project Space, and Projects. 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.
As an Org admin or Pipeline Designer, you You can track the popularity of an API or analyze target and response errors to understand how to enhance the API consumer experience.
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
Articles in this section
|
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.
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.
Limitations
Limitations
Orgs with APIM should not use Enhanced Encryption for the following reasons:
Orgs with Enhanced Encryption do not support subscriptions on the Developer Portal.
Org admins who rotate keys for their Groundplexes must also reconfigure all API policies as well for them to work.
Only one instance of an API policy type is applicable at each level in the hierarchy.
API Manager does not support Scheduled Tasks. When you open a Task in an API version, you
do not have the option to change the Run Policy to Scheduled.
In Designer, when you open a Pipeline in an API version, the Snaplex
picker in the Edit Pipeline dialog window only
show the Snaplex instances from the global
sharedfolder. If a Snaplex is in a project or Project Spacesharedfolder, then it does not display in the APIM Snaplex picker.In Designer,
if you open the Snap dialog window
from a Pipeline in the API Management -
/apimspace,
the asset or account selectors display only the assets from the global shared folder, in addition to those in the current version.
You can change
the Snaplex for an unpublished API
version. To do so, go to API Manager, choose the API, go to the Versions tab, choose the version, click Edit Details, and choose from the Server dropdown. Note: This field is disabled if the API version is published or if the Snaplex is down.
Server Configuration
You cannot use the Cloud URL to run the Triggered Tasks in your API Versions.
When you generate a specification using version OAS 3.0 in an API proxy that has a valid endpoint, the generated specification does not list a server.
Prerequisites
The API Manager feature requires a load balancer.
Cloudplexes need a Cloudplex FeedMaster node and a load balancer for the API Policy Manager to work.
Contact support@snaplogic.com to provision the Cloudplex FeedMaster node and the load balancer as needed.
When the load balancer becomes available, your Org admin must update the Load Balancer
URL in
the Snaplex
Refer to this page for more information: Updating a Snaplex See Also
Settings. Learn how: Updating a Snaplex
You must use the load balancer URL in your Triggered and Ultra Task endpoints.
The API Management feature must be enabled for your Org. Contact SnapLogic Support to subscribe to this feature.
API Management Architecture
The following diagram illustrates the components of API Management Architecture.
The Design-First Workflow
You can create a new API in the /apim space of the API Manager and import or reference an API specification that defines the API. 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, and modify the underlying SnapLogic assets to build the business logic for your API.
The following video demonstrates the workflow:
Learn more: Creating the API using Design First
The Pipeline-First Workflow
You can also create an API in the API Manager by referencing existing Projects in Manager. This allows you to design, build, and test your Pipeline first, thereby taking advantage of your existing SnapLogic infrastructure. As you build Pipelines and create Triggered Tasks from them, you vet them for production individually and concurrently. When your Pipeline and Tasks are production-ready, you can create APIs in the API Manager.
The following video demonstrates the workflow:
Learn more: Creating the API from Existing Project Assets
Known Issues
When you generate a specification using version OAS 3.0 in an API proxy that has a valid endpoint, the generated specification does not list a server.
Workaround: Edit the specification to include the server field and list the Snaplex manually.