Versions Compared

Key

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

In this article

Table of Contents
maxLevel2

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

  • 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

    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.

    • Snap Packs. Snap Packs that are used by the 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 it

      or reference a URL

      with the

      containing your specification.

      Versioning: The ability to create multiple versions of an API based using an OAS 2.0 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

      for

      of your

      initial

      API, then create and publish a new

      versions

      version from

      those

      the 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.

    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

    • Dashboard: The dashboard displays
    • 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.

    • 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.

    •  
    PanelbgColor#ebf7e1

    Prerequisites

    • Cloudplex instances 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 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.

    Articles in this section

    Children Display
    alltrue
    depth3
    pageSnapLogic API Management


    Prerequisites

    API Management Architecture

    Image Removed

    Image Added

    The

    API Management

    Design-

    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

    Image Removed

    When you

    First Workflow

    Image Added

    You can create a new API in the /apim space of the API Manager and import or reference an API specification

    to the new /apim space, a new API asset is created

    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,

    set permissions,

    and modify the underlying SnapLogic assets to build the business logic for your API.

    Create New API from existing Pipelines and Tasks

    Image Removed

    Learn how: Creating the API using Design First

    The Pipeline-First Workflow

    Image Added

    You can also create an API in the API Manager

    Console

    by referencing existing Projects in Manager. This

    functionality enables

    allows you

    , as a Pipeline designer, to complete your Pipeline building activity first. The advantage of this approach is

    to design, build, and test your Pipeline first, thereby taking advantage of your existing SnapLogic infrastructure.

    You can segment the design and testing activities as

    As you build Pipelines and

    creates

    create Triggered Tasks from them

    individually testing and vetting

    , you vet them for production individually and concurrently.

    Once

    When your Pipeline

    assets

    and Tasks are production-ready, you can create APIs in the API

    creation dialog windows.

    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

    Manager. Learn more: Creating the API from Existing Project Assets

    Limitations

    • Only one instance of an API policy type is applicable at

    a
    • each 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
    • if you open the Snap dialog window

    opened
    • from a Pipeline in the API Management - /apim space,

    only shows
    • 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

    a
    • the Snaplex for an unpublished 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
    • 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

    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