Versions Compared

Key

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

...

Prerequisites

  • Org Admin role

Launch the Dev Portal

Users with a SnapLogic platform login can open the Developer Portal with one click from the Apps menu:

...

Set Up Your Developer Portal

...

Developer Portal Settings

Setting

Description

Portal URL Suffix

The suffix for your Developer Portal URL.

What you enter in this field is automatically appended to Portal URL.

Portal URL

(Read-only) The full URL to your Developer Portal.

To copy your Developer Portal URL to your clipboard, click the copy icon ( (blue star) ) next to the Portal URL value.

Icon

The thumbnail image for your Developer Portal.

The image must be JPG, PNG, or SVG with a maximum image size of 256px x 256px and a maximum file size of 10MB.

Banner Image

The background image for the landing page of your Developer Portal.

The image must be JPG, PNG, or SVG with a maximum image size of 2000px x 1200px and a maximum file size of 10MB.

Portal Title

The title of your Developer Portal. This appears at the top banner of all pages of your Developer Portal.

Must be no more than 50 characters.

Banner Image Text

The title displayed over your banner image in the landing page.

Must be no more than 120 characters

Banner Text Alignment

The position of the Banner Image Text on the landing page: Left, Center, or Right.

Terms of Service URL

The URL where API consumers can read the terms of service for using your Developer Portal and your APIs.

Company Website URL

Your organization’s website.

Contact Us - Email Address

The email address where your API consumers can contact you.

Manage Categories

Categories to classify published APIs in the Developer Portal.

Note

Category names must be unique within the Org.

Documentation – OpenAPI Viewer

(Read-only) The type of API documentation used for each API published in the Developer Portal.

CORS Setting » Enable Try Me

If selected, API consumers can try out an API to see what it returns before subscribing to it.

Note

For older JCC nodes (Snaplex Version 4.28 and older), changes to this setting might not take effect for up to two hours due to caching.
Learn how to determine your Snaplex’s version.

If a CORS Restriction policy is defined at the API or API version level, that policy takes precedence over the default CORS settings for the Developer Portal.
Learn how to configure a CORS Restriction policy at the API or API version level.