This chapter provides a structured guide for new users to onboard, configure, and navigate ApiShare efficiently.

Prerequisites and System Requirements

• Supported Browsers: Chrome, Firefox, Edge (latest versions).

• Authentication Methods: Access with username/password, Single Sign-On (SSO) available on request.

• API Gateway Integrations: See the section on available standard connectors for detailed integration options.

• DevOps Compatibility: Compatible with major DevOps tools for seamless integration.

Navigating the Interface

After logging in to ApiShare, you will be redirected to the ApiShare Homepage, which provides an intuitive interface designed to help users quickly access essential functionalities.

Homepage Overview

The homepage features the following key sections (This layout may vary slightly based on specific configurations within your ApiShare instance) :

• High-Level KPI Board
  Displays real-time insights into your company’s API ecosystem:

  • Total Products published and visible in the API catalog.

  • Total Assets in the API catalog.

  • Total Active Applications visible in the APP catalog.

  • Total Groups, Organizations, and Users in the API program ecosystem.

• APIs & Applications Categories Overview
  Displays API Products, API Assets, and Applications, based on your instance configuration.

• Future Features Preview
  Highlights upcoming ApiShare functionalities.

Top Menu Bar

The top menu bar provides quick access to essential actions:

• Quick Actions:

  • Create a new API or Application.

  • Request to join an organization.

• Notification Panel:

  • View notifications.

  • Pin and configure alerts based on profile settings.

• User Account Overview:

  • View username, name, and email.

  • Check organizations and groups you are part of.

  • Manage roles and permissions.

⚠ Note:
If you log in via SSO, you cannot modify your email or username.
For assistance, contact your ApiShare administrator.

Side Menu Bar

The Side Menu Bar in ApiShare provides quick access to the platform’s core functionalities. It is located on the left side of the interface and can be expanded or collapsed using the designated button.

The main sections available in the side menu are:

Home Page

Redirects users to the ApiShare homepage, where key insights are displayed, including API and APP categories, main KPIs, and a preview of upcoming features.

• API Catalog

  • Provides access to the API Catalog, which stores all available APIs within the organization.

• APP Catalog

  • Lists all active applications registered on the platform.

• Workspace

  • A dedicated area where users can manage ApiShare entities (i.e. APIs, applications, subscriptions).

• Organizations

  • Allows users to manage organizational structures, internal teams, and external consumers.

• Documentation

  • Provides access to general documentation, including for example user guides, API guidelines, and best practices for API governance.

• Administrator

  • Reserved for users with administrative privileges to configure platform settings, manage policies, and define governance rules.

API & APP Catalogs

API Catalog

The API Catalog stores all available APIs in your organization.

Searching APIs

• Use the multifunction search bar with free-text search.

• Apply filters by clicking on the searchbar (i.e. API owner, developer, organization, group, category, tags).

• If the instance separates Products and Assets, a master filter lets you switch views.

API Details

Each API entry contains:

• Description: Purpose and functionality.

• Lifecycle Status: Current stage, deployment history, and upcoming changes.

• Testing Capabilities: OpenAPI definition and Swagger interface for testing.

• Deployment Information: Availability across deployment environments.

• Technical Details: API specifications.

• Subscription & Usage: Consumer and provider applications.

APP Catalog

The Application Catalog lists all active applications.

Searching Applications

• Use the search bar with free-text search.

• Apply filters by clicking on the searchbar (i.e. owner, developer, responsible group, consumed/exposed APIs, tags, categories).

Application Details

Each Application entry contains:

• Description: High-level overview of the application’s function.

• Lifecycle Status: Readiness to consume or expose APIs.

• Contact Persons: Support contacts.

• Exposed and Consumed APIs: APIs linked to the application.

⚠ Note:
If your tenant is configured in Product-Only Mode, Assets are not visible.

Visibility & Access Control

• Internal Users: Have full access into their workspace to all APIs owned by their organizations and groups in their tenant.

• Both Internal & External Users: Can only access explicitly granted APIs on the API Catalog.

• Asset Visibility:

  • External users cannot see API Assets.

  • Internal users can see both Products and Assets.

First Steps: Setting Up Your Environment

New users should configure the following:

1. Define your initial configuration or chose the default one:

   • Set up your ApiShare environment

2. Define Organization Structure

   • Set up internal teams and external consumers.

   • Assign administrators, developers, and API consumers with appropriate permissions.

3. Configure your processes

   • Define subscription approval workflows.

   • Set up API & APP lifecycle (versioning, deprecation rules, etc.)

   • Define access control rules for default API & Documentation visibility.

4. Create your First Application & Onboard Your First API

By following these steps, users can seamlessly integrate ApiShare into their API governance workflows and maximize its benefits.