...
Technical Name
...
The technical name of an API must be unique.
...
Display Name
...
The display name can differ from the technical name and does not have to be unique.
...
Image
...
The image of the API. It is also displayed in the Developer Portal.
...
Organization
...
The organization of the API. 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 overview.
...
Description
...
The description of the API is displayed in the Developer Portal.
...
Specification
...
The specification of the API product.
E.G.: AWS Default: Unknown
...
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)
You can also select API products within the table and delete API product, but not the underlying APIs.
In the “Name” column, you will not only see the display name, but also the image and the API product tags created. You can filter API products by clicking on one of these tags above the table under Filter by Tag. This filter option is identical to the one in the Developer Portal.
The respective platform of the API product is named in "Platform". An API product must consist of APIs from one platform or universal APIs.
In “Deployed On” you can see in which environment the API product is currently deployed.
In "Visibility" it is listed whether this API product is visible to users from all organisations in the administration portal or whether visibility is restricted.
"Published" indicates whether this API Prod is visible in the Developer Portal.
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
...
Fill in the form (as
...
...
...
Confirm by clicking on the "Create New API Product" button
...
Table of Content
| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|