Managing your API Portal Settings

In this article

Overview

You can customize the appearance of your developer portal landing page. The Portal Manager > Settings tab enables you to brand the cover page of your developer portal. You can also modify the suffix of the developer portal URL.

Because the developer portal can be accessed by anyone who has the URL, all developer portal users have at least read-only access to your published APIs. We strongly recommend that you set up API policies to manage access to your published APIs.

Setting up your Developer Portal

Before you can display your published APIs in the developer portal, you must set it up in the Portal Manager.

  1. Navigate to API Management > Portal Manager > Settings.

  2. Enter the information for each field.

    See API Portal Settings section below for details about each field.

  3. Click Save. You can modify these settings at any time.

  4. Validate your settings by clicking to launch the developer portal.

API Portal Settings

Setting

Description

Setting

Description

Portal URL Suffix

Enter the URL suffix for your developer portal.

Portal URL

The final Portal URL for your Org’s developer portal. Click to copy the URL for sharing with basic users and API consumers without SnapLogic credentials.

Icon

Upload one of the following image types for the thumbnail image:

  • JPG

  • PNG

  • SVG

The maximum size is 256px x 256px with a total file size of 10MB.

Banner Image

Upload one of the following image files for your portal banner. This image is on the developer portal cover page:

  • JPG

  • PNG

  • SVG

The maximum size is 2000px x 1200px with a total file size of 10MB.

Portal Title

Enter the title of your API Portal.
The maximum length is 50 characters.

Banner Image Text

The max length is 120 characters

Banner Text Alignment

Select Left, Center, or Right to align your banner text on the landing page.

Terms of Service URL

Enter a URL for support questions.

Company Website URL

Enter a company URL for your API Portal.

Contact Us - Email Address

Enter an email address for customer contact.

Manage Categories

Enter categories to classify published APIs in the developer portal.

Documentation – OpenAPI Viewer

This field indicates the type of API documentation used.