General Info
If you select one of the developer portals from the table, you can view and edit details about the developer portal on the first tab 'General Info'. The Developer Portal can be deleted or the authentication token can be renewed via the three-dot menu at the top right.
Status
A disabled Developer Portal, is no longer accessible.
Guest Access
With this option you can enable/disable the guest access in the Developer Portal. If the option is disabled, a user must log in. Except for the login screen, there is no function for users who are not logged in. If the option is enabled, users can access the home page and list of APIs of their Developer Portal without login. The list of available APIs in guest mode is composed of all 'published' APIs that have the visibility setting 'Public'. Furthermore, Guests can register in their Developer Portal to subscribe to APIs.
Name
The name of the Developer Portal is displayed in the login screen.
Organization
If the organization is set for a Developer Portal, this Developer Portal is exclusive for this organization and has e.g. an impact on the visibility of APIs.
Developer Portal URL
The URL of the Developer Portal. Important for the CORS. The initial Developer Portal has the link: https://.portal.apiida.io
Display Owner Information
If this option is active, the owner information organization name and organization email will be displayed in each overview of API and API product.
Allow Changing Plan for Subscriptions
Allow users in the DevPortal to switch the plan of a subscription at a later date without having to delete and recreate the subscription. No approval request is triggered.
Email Footer
The footer of all emails sent by the developer portal. For example, when a user is invited.
Customization
On the second tab "Customisation" you can customise the general look and feel of the developer portal. The preview shown below gives you a first impression of how your customised developer portal will look.
Menu
On the third tab, "Menu", you can create additional main menu items for your develpoper portal and determine their position. The menu items created here are displayed below the default menu.
When creating a new item, you first select whether it refers to an external page (e.g. https://apiida.com ) or an internal page. You can manage the internal pages under the fourth tab item 'Pages'. You also assign a name and an icon to the new menu item.
The 'menu item icon' is located to the left of the 'menu item name' in the page navigation. Here you have to enter the name of the icon from the icon directory. There is a format to follow: 'briefcase' becomes 'BriefcaseIcon' and 'chat-bubble-left' becomes 'ChatBubbleLeftIcon'.
Finally, depending on the type, select an internal page or enter a link to an external page. The internal pages are divided into default and custom pages.
Pages
On the fourth tab, "Pages", you can view all existing default and custom pages. Default pages are placeholders on 'predefined pages'. The name of a default page indicates on which 'predefined page' it is used. The page is always displayed at the top of the 'predefined page'. A default page cannot be deleted.
To create a custom page, enter a name and a title.
The page name must be unique, because it is used to identify the page. A page can be added to one or more menu items.The name cannot be changed afterwards.
The page title is displayed in the Developer Portal in the header section of the web page. This title is freely selectable and can be changed.
Terms of Use
On the fifth tab, "Terms of use", you can view and manage all terms of use for the Developer Portal. The terms of use assigned here are displayed to a new registered user before the password is set. The user must agree to these terms of use in order to gain access to the Developer Portal. The terms of use are managed here: Terms of Use
