Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
  • Ultra Task Pipelines
  • Triggered Tasks

    On this page

    Table of Contents
    maxLevel
    2
    3
    minLevel1
    outlinefalse
    typelist
    printablefalse

    Overview

    The API Management > Portal Manager is the administrative console where Org admins can manage the lifecycle of APIs. Org admins can use the Portal Manager to customize the appearance and URL of your Developer Portal landing page. You can make your APIs accessible to users outside of the SnapLogic ecosystem in the API Portal. Org Admins can create a Developer Portal for API developers to publish their APIs. The Developer Portal is the public-facing page where users can explore your APIs.

    Key Features

    Portal Manager

    You can use the Portal Manager to publish, unpublish, deprecate, and retire versions of APIs. As an Org Admin, you can create a Developer Portal for your API developers to publish their APIs. The API Management > Portal Manager is the administrative console where you can manage the lifecycle of your APIs. The Developer Portal is the public facing page that consumers use to explore those APIs.

    Key Features

    • 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.
    Panel
    bgColor#ebf7e1

    Articles in this section

    Child pages (Children Display)
    alltrue
    depth3

    See Also

     

    Watch this video for a demonstration of using the Portal Manager to publish an API.

    Manage the API Lifecycle.mp4

    Learn more at Managing the API Lifecycle.

    Developer Portal

    You can customize the appearance and URLs of the Developer Portal landing page and manage the API categories displayed in the Developer Portal. 

    Watch this video for a demonstration of how to set up the Developer Portal for your Org.

    Manage SL API Developer Portal.mp4

    Learn more at Managing your Developer Portal Settings.



    Pages in this article

    Child pages (Children Display)

    Prerequisites

    You must be an Org admin to perform most of the operations in this article.

    Searching for APIs in the Portal Manager

    The Portal Manager features a table of all the APIs that are available in your API Catalog. You can search for APIs and manage their status in the Portal Manager.

    Finding an API Asset by Type

    1. In Manager, click Portal Manager.

      Image Added
    2. In the Search field, enter a term.

    3. In the Filter by Type dropdown, pick one of the following based on your criteria:

      • API

      • Proxy

    Finding an API by Status

    1. In Manager, click Portal Manager.

      Image Added
    2. Enter a term in the Search field

    3. In the Filter by Status dropdown, select one of the following based on your criteria:

      1. Published

      2. Deprecated

    Managing Developer Portal Status for your APIs in Portal Manager

    You can publish, unpublish, republish, deprecate, and retire APIs directly in the Portal Manager.

    Unpublish APIsImage Added

    You can also open the API version dialog by clicking the target API and then change its status on the API > Version Details tab. Learn more about publishing, unpublishing, republishing, deprecating, and retiring versions of an API in Managing the API Lifecycle.

    Related Content