The Public Showcase is available if enabled for your installation. The FAQ, Contacts, Log In and Sign Up pages can be enabled individually, so some of the sections below may not be available in your Showcase.

Introduction

The Public Showcase is accessible to anyone through its public internet address and functions like a standard website. It allows visitors to explore published APIs, documentation, FAQs, and contact forms without requiring direct access to the Platform. The header of the Showcase can also include custom buttons, configured for your installation, that link to other resources of the organization.

The navigation bar shows the API Catalog and Documentation buttons; the other pages (Home, FAQ, Contacts, Sign Up and Log In) are reached from the menu of the navigation bar.

Browsing the Public API Catalog

Steps:

1. From the Home page, click the API Catalog button in the navigation bar.

2. Browse the list of available APIs using scrolling, the search bar, keyword editing, or filters.

3. Select an API to open its Identity Card, which displays general details, technical details (messaging pattern, data format, authentication type and the downloadable OpenAPI definition) and the reviews in read-only mode.

4. Access additional subsections:

   • Documentation: API-specific documentation.

   • Try it (OpenAPI): Test the API directly with sample calls.

Tips:

• To actively use an API, click Log in to subscribe on the API card in the catalog or within the API’s Identity Card.

• If logged in, you will be redirected to the platform’s API subscription section.

• If not logged in, you will be redirected to the Login page.

• If you do not yet have an account, you will be directed to the Sign Up page.

Accessing documentation

Steps:

1. From the Home page, click the Documentation button in the navigation bar.

2. Use the left sidebar to browse the list of documentation pages, organized into sections.

3. Use the right-hand table of contents to navigate within the current page.

4. Use the breadcrumb navigation below the navbar to return to previous sections.

Tips:

• Only documentation with public visibility is shown in the Showcase.

Viewing FAQs

Steps:

1. Open the menu of the navigation bar and choose FAQ.

2. Click a question to expand its card and view the answer.

Using the Contact Form

Steps:

1. Open the menu of the navigation bar and choose Contacts.

2. Fill in the required fields.

3. Accept the privacy policy.

4. Click Send to submit your request, which will be forwarded to the configured email address.

Signing Up or Logging In

Steps:

1. Open the menu of the navigation bar and choose Log In or Sign Up.

   • Log In: Use existing credentials to access the platform.

   • Sign Up: Complete the registration process if you do not yet have an account.

2. Based on the option selected, you will be redirected to the corresponding page (Login or Sign Up).