Picture Picture Dev

Docs & guidelines > Getting started

About the API product details

On the product details pages, you have the following options:

  • In the left column, you can see the list of your currently subscribed API products with their subscription status. The API products are listed with their display names that have been configured for your account-related subscriptions. The display names can be modified at any time on Your profile page. On the profile page, you also see in addition to the display name the original name of your subscribed API products.

  • Read through the details of the currently selected API product.

  • With the help of the pull-down menu on the upper right, you can easily switch to the details pages of another API product.

  • With the subscription form and button, you can subscribe to the currently displayed API product. In order to call a teamplay API it is required to subscribe to a specific API product in the instance-specific Siemens Healthineers Developer Portal. The API product subscription submission generates a subscription key for the currently signed-in user. This subscription key is required in a HTTP request header value with every API call.

See also

Managing your subscriptions (article)

To subscribe to an API product, do the following:

  1. Log in with your teamplay developer account to the required portal instance such as sandbox, formal test or  regional productive environments. We recommend to use your functional team account when subscribing to an API product. Especially, for the production environment, your subscriptions must be easy to maintain and to administrate within your development team.

  2. Enter your new product subscription name that will be displayed as an alias for the original API product name. Your product subscription names must be as meaningful as possible in order to support your administrator to immediately recognize relevant subscriptions in case of stack modification requests. Follow the naming convention provided next to the subscription field.

  3. Click the Subscribe button to finally subscribe to the displayed API product. On your profiles page, you can maintain your submitted subscriptions.