DevIn this article
teamplay Base (in work)
Most of the common API gateway functions of the teamplay digital health platform are covered by teamplay Base APIs. Thus, it is important to subscribe at least to teamplay Base API products before you can start using APIs of other Siemens Healthineers offerings.
APIs
teamplay Base - Users, Institutions, Permissions, etc.
teamplay Base - Token Authentication
teamplay Base - Provision Applications
teamplay Base - Authentication Metadata
teamplay Base - Entitlement (Licensing)
API products
Functional overview
The currently available APIs offer and support the following functions:
general
xx
teamplay Base - Users, Institutions, Permissions, etc.
xx
teamplay Base - Token Authentication
Auth0 authentication is supported
teamplay Base - Provision Applications
xx
teamplay Base - Authentication Metadata
xx
teamplay Base - Entitlement (Licensing)
Bases on the business system Zuora
As of version 4, for the following endpoints, the API defines a rate limit of 20 calls per minute within an APIM source:
GET: /entitlement/Features/{featureId}
GET: /entitlement/Products/{productName}?[&ratePlan]
GET: /entitlement/Features
GET: /entitlement/Products?[&status]
For all other endpoints, the API does not define a rate limit. The other endpoints can be called without a rate limitation. This is especially valid for the endpoint:
GET: /entitlement/Features/IsEntitled?features={features}
Usage counters are managed separately from the actual product features (licenses)
Rate plans reflect different pricing models such as Basic, Enterprise or Campus
As of version 4, the API also offers an entitlement health check operation.
In this portal
For registering your partner application and for subscribing to an API product, follow the instructions on the Sign-up page
Prerequisites
The following prerequisites apply.
general
Application ID:
Your application has been registered for an integration with teamplay digital health platform.
API subscription:
You have already active API subscriptions for the required teamplay Base products.
Authentication:
You got a valid token by following the recommended workflow for Auth0 authentication.
The client application passes the bearer token (OAuth JWT) in the request header.
teamplay Base - Users, Institutions, Permissions, etc.
xx
teamplay Base - Token Authentication
x
teamplay Base - Provision Applications
xx
teamplay Base - Authentication Metadata
xx
teamplay Base - Entitlement (Licensing)
xx
See also
x
Utilizing the service
To utilize the service, perform the steps that are listed for each API.
teamplay Base - Users, Institutions, Permissions, etc.
xxx
teamplay Base - Token Authentication
xxx
teamplay Base - Provision Applications
xx
teamplay Base - Authentication Metadata
xxx
teamplay Base - Entitlement (Licensing)
xx
As of API version 3, add the tenant ID for all teamplay Base - Entitlement (Licensing) APIs to the header of your request.
In this portal
x
Customization
There are the following options to customize the usage of the APIs.
general
xx
teamplay Base - Users, Institutions, Permissions, etc.
xx
teamplay Base - Token Authentication
xx
teamplay Base - Provision Applications
xx
teamplay Base - Authentication Metadata
xx
teamplay Base - Entitlement (Licensing)
xx
Limitations and restrictions
The following limitations and restrictions are currently known.
general
Authentication:
For security reasons, passing the JWT token in URI is deprecated.
JWT tokens can be only passed through request headers.
teamplay user tokens are deprecated
teamplay Base - Users, Institutions, Permissions, etc.
teamplay Base - Token Authentication
xx
teamplay Base - Provision Applications
xx
teamplay Base - Authentication Metadata
xx
teamplay Base - Entitlement (Licensing)
xx
In this portal
In the API gallery, see "teamplay User Notification" APIs and see also "teamplay Data Repository" APIs
Example scenarios
Here are some example scenarios to depict the usage of the APIs.
general
xx
teamplay Base - Users, Institutions, Permissions, etc.
xx
teamplay Base - Token Authentication
xx
teamplay Base - Provision Applications
xx
teamplay Base - Authentication Metadata
xx
teamplay Base - Entitlement (Licensing)
xx
--------------- go to the top of this article --------------->>