Portal

Your Boomi Cloud API Management-powered Portal is the primary interface between your API program and your developers. It is the application that they use to learn about your APIs, to get keys, and to view reports. The Portal is a highly configurable and customizable application, and Portal Settings is the primary tool used to set up these customizations, thereby giving you tremendous control over the developer experience.

General

The General tab allows you to customize the look and feel of the Portal and its functionality, set notification alerts and emails, and enable or disable content features such as search, blog, documentation, forum, and Interactive Documentation.

It enables Portal administrators to set the Portal name, which is the name of the client Portal. The Portal name appears at the top of every page on the Dashboard.

note

Only Administrator and Portal Manager roles can access the General tab.

Portal Setup

The Portal Setup tab allows you to configure Portal settings such as Logo, JavaScript (custom and inline), CSS (custom and inline), primary navigation links, and Footer (links and copyright).

Domain Names

The Domain Names tab lets you add domains, set the primary domain, and configure redirects. It also allows you to specify domain settings like HTTP Authentication, IP restrictions, and reCAPTCHA for the Portal. Additionally, you can set access restrictions for the Portal using HTTP Authentication and IP restrictions.

You can configure the following settings on the Domain Names page:

Domains: Refer to Adding Portal Domain Name for more information about adding a domain.
Redirects: Refer to Adding Domain Name Redirect for more information about adding redirects.

Content

The Content tab allows you to enable sections on the Portal, such as Wiki, blogs, forum, documentation, and Interactive Documentation. You can also configure moderation settings for specific sections.

Contact Form

The Contact Form tab allows you to set contact information for the Portal that users can use to submit feedback.

Notifications

The Notifications tab allows you to set notification email addresses. Based on the type of action on the Portal, a notification email is sent to the email address mentioned on this page. For example, when there is a new user registration, a new application is registered, a new key is issued, or if Call Inspector is enabled or disabled.

Emails

The Emails tab allows you to configure email settings for new member registrations and new issued keys.

The Login tab allows you to set the Portal name and logo for the login page.

Integration

The Integration tab allows you to manage system event triggers and an API so you can easily integrate Cloud API Management into your system. Event triggers make an API call to your system whenever certain events occur. The Cloud API Management API gives you read/write access to most Cloud API Management objects.