Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Technical Name

...

The technical name of an API product must be unique.

...

Display Name

...

The display name can differ from the technical name and does not have to be unique.

...

Description

...

The description of the API product is displayed in the Developer Portal.

...

Image

...

The image of the API product. It is also displayed in the Developer Portal.

...

Organization

...

The organization of the API product. Who is allowed to see it also depends on this.

...

Tags

...

With the tags you can categorize APIs. e.g. you can search for the tags in the API product overview.

...

Platform

The platform of the API Product is determined by the first API that is added.

...

Managing APIs as API products offers several advantages over individually managing each API. Firstly, it enables consistent management and standardization across all APIs, increasing efficiency and reducing complexity. Additionally, it facilitates the implementation of uniform security policies and governance mechanisms, enhancing security and reducing the risk of errors. Centralized management allows for more efficient resource utilization and harnessing synergies between different APIs. Furthermore, it simplifies monitoring and analysis of API performance and usage, leading to better-informed decisions and continuous improvements. In summary, managing APIs as products enables a more holistic and strategic approach to API development and management, ultimately resulting in improved user experience and greater value creation.

Moreover, adopting a federated approach to API products allows organizations to seamlessly integrate APIs from multiple sources, fostering collaboration and innovation across distributed teams. This approach enables organizations to leverage the strengths of different API providers while maintaining centralized control and governance over the entire ecosystem.

As next, the documentation will proceed to explain how to implement these advantages effectively. If you want to learn more about the basic concepts, you can do so in the following chapter: APIs, API Products, Versions and Plans

All your API Products

The ”API Products” menu item on the left takes you to the overview of all API products. In the top right-hand corner, you can create new API products. (See below)

ApiProductList-20240327-092647.pngImage Added

Create a new API Product

  • Navigate to “API Products” in the menu on the left side

  • Click on the “Create New API Product” button in the top right corner

ApiProductList-20240209-133328.pngImage Modified

  • Fill in the form (as shown in the following example)

ApiProductCreateFilledDialog-20240209-133506.pngImage Modified

  • Confirm by clicking on the "Create New API Product" button

ApiProductCreateCreated-20240209-134033.pngImage Modified

(tick) You’ve create an API Product

Table of Content

Table of Contents
minLevel1
maxLevel6
outlinefalse
styledisc
typelist
printablefalse