Versions Compared

Key

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

Overview

In the API product settings you can make basic configurations, e.g. change the name or the image of the API product.
In the settings, you can make the advanced configurations "Tags".
At the top right you can delete the entire API product using the corresponding button.

ApiProductDetailsSettings-20231205-101216.png

Settings of the API Product

All relevant setting options are listed and described in the table below.

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.

API products can only contain APIs of one platform. With the exception of Open Proxy Specification APIs, these can always be added.
E.G.: AWS Default: Unknown

Table of Content

Table of Contents
minLevel1
maxLevel6
outlinefalse
styledisc
typelist
printablefalse