Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

To make the use of your API as easy as possible for the end customer, you have a free hand in documenting.

Admin Portal

You can work freely with Markdown or rich text and create a folder structure according to your wishes. You can even create a folder, link it to git and get your documentation from there.

ApiDetailsDocumentation-20231110-171212-20240209-113035-20240328-110458.png

If you navigate to the Documentation menu item within an API in the second navigation menu, you will see the first level of the documentation listed in tabular form.

In the top right-hand corner there is a button that you can use to create a new item within the documentation, more on this below.

There can be different types of documentation items in the table:

  • Markdown: The Markdown type creates documentation of the Markdown type, which can be created and edited using a special Markdown editor.

  • Rich Text: The rich text type creates documentation of the type rich text. Using a special text editor, simple text and HTML documentation can be created and edited.

  • Folder: The Folder type creates a folder that can contain all types of documentation

The table itself is divided into three columns:

  • Type: The type of the item is indicated by means of a symbol:

    • image-20240328-141711.png: Markdown type

    • image-20240328-141655.png: Rich Text type

    • image-20240328-141723.png: Foder type

  • Name: Specifies the name of the item, which must be unique.

  • Status: Indicates the status of the item, whether the item is visible in the developer portal 'published' or 'not published'.

You can click on the individual entries in the table to access the specific item.


If the selected entry in the table is of the 'Folder' type, you will be forwarded one hierarchy level to the folder. There you then have two further menu items in the third navigation area:

  • Content: In the content area, you will see the familiar table from the first hierarchy level.

  • Settings: In the settings area you can make various settings, more on this below.

You also have a drop-down menu in the top right-hand corner, which you can access via the three dots. There you can delete the current folder if it contains no further items and create new items.

If the type is 'Markdown' or 'Rich Text', you will be redirected to an edit page of the corresponding type. This area has a third navigation bar with the menu items:

  • Content: a special editor is displayed here depending on the type, see below.

  • Settings: Various settings for the item can be made here, see below.

You can also delete the current item in the top right-hand corner using the 'Delete Item' button.

Create Item

ApiDetailsDocumentationCreate-20231110-172759-20240209-113515-20240328-110324.png

To create a new item, select the button in the top right corner 'Create New Item' or the menu item of the same name from the dropdown in the same position.

A new dialog window will then open in which you have various input fields and options:

Name: The 'Name' input field specifies the name of the item. The name must be unique in the API documentation.

  • Type of the Item: You can choose between three types of item: ‘Folder’, ‘Markdown’, ‘Rich Text’.

    • The ‘Folder‘ type creates a folder that can contain all types of documentation.

    • The ‘Markdown‘ type creates documentation of the Markdown type, which can be created and edited using a special Markdown editor.

    • The ‘Rich Text‘ type creates documentation of the type rich text. Using a special text editor, simple text and HTML documentation can be created and edited.

  • Toggle 'Welcome Page of this API': This toggle is only visible for the types 'Markdown' and 'Rich Text'. Use this option to specify which documentation page should be displayed as the overview page in the developer portal for the corresponding API. Only one documentation can be selected as a welcome page at a time. The last setting overwrites the previous one.

To create the item, click on the 'Create New Item' button.

Edit Item - Markdown

ApiDetailsDocumentationMarkdown-20240209-112931-20240328-110528.png

Edit Item - Rich Text

With the type rich text you get a graphical editor with which you can easily and conveniently create documentation. You can also use this type to create your documentation in html.

A summary of all HTML templates can be found here: CMS Template Library

ApiDetailsDocumentationRichText-20231110-172136-20240209-112908-20240328-110600.png

ApiDetailsDocumentationRichTextEdit-20231110-172403-20240209-112824-20240328-110637.png

Settings - Markdown & Rich Text

image-20240328-143259.png

Settings - Folder

image-20240328-143349.png

Developer Portal

  • No labels