DevDocs & guidelines > Getting started
Getting yourself onboarded
The initial onboarding steps will help you get your application up and running on the teamplay digital health platform.
In this article
See also
teamplay digital health platform (article)
Partner management contact (sign-up page)
Sharp service port (Healthineers-internal ticket tool)
1. Apply and register as a new business partner
If you´re interested in enriching your applications by consuming our APIs, you must first apply as a new business partner for the teamplay digital health platform:
As an external business partner, follow the instructions on the Sign-up page. The Siemens Healthineers partner management gets in touch with you as soon as your request has been assessed.
As an internal business partner, raise a ticket through the Sharp service port.
See also
Partner management contact (sign-up page)
Sharp service port (Healthineers-internal ticket tool)
List of portal environments (article)
2. Request a teamplay developer account
To get access to this portal including the API documentation, you must request a teamplay developer account:
As an external business partner, follow the instructions on the Sign-up page. The Siemens Healthineers partner management will inform you as soon as your AAD user account has been created.
As an internal business partner or developer, raise a ticket through the Sharp service port.
Subscriptions and most of the required registrations are directly connected to your AAD account that is used during logging in. We strongly recommend requesting a functional account for your developer team to allow all your team members to access your API subscription keys and to benefit from your registrations.
To ensure a proper communication on deprecated APIs or on other time-critical issues, keep your referenced e-mail address for your teamplay developer accounts up-to-date.
Frequently check your e-mails that you received for your teamplay developer account.
See also
List of portal environments (article)
Partner management contact (sign-up page)
3. Log on to the Developer Portal
After you´ve received your teamplay developer account and the required access rights, log on to the Siemens Healthineers Developer Portal to activate your teamplay developer account.
By clicking the button on the upper left side in this portal page, the Environment page opens, which contains links to further environments. In case of issues to access an environment, get in touch with us:
As an external business partner, follow the instructions on the Sign-up page. The Siemens Healthineers partner management will inform you as soon as your AAD user account has been created.
As an internal business partner or developer, raise a ticket through the Sharp service port.
See also
Options for accessing your applications (article)
Example workflow with user tokens (article)
4. Integrate user authentication in a user-related context
Depending on your use cases, your cloud-based applications might require integration of user authentication. Thus, your users can access your application by logging in with their Siemens Healthineers ID and password on the Siemens Healthineers Login page.
See also
About the API product details (article)
teamplay Base APIs (article)
Subscribing to API products (article)
5. Subscribe to the teamplay Base API product
At least subscribe to the teamplay Base APIs. The teamplay Base APIs (alias Core APIs) provide you beyond other services a common infrastructure to manage your applications and to generate applications tokens.
With your teamplay developer account, you´re able to subscribe and consume many of the Siemens Healthineers APIs. Nevertheless, you retain end-to-end responsibility for the functions that you implement in your application.
See also
Managing your application tokens (article)
6. Register your application for token generation
Registering your application is required before you can generate application tokens for machine-to-machine communication.
For details on how to register your application, see the article Managing your application tokens.
7. Validate generated user and application tokens
Depending on your use cases and the token types you process, to validate tokens with your application back-end before calling our APIs, you must implement a set of validation steps.
See also
Difference between the portal environments (article)
Links to the supported portal environments (article)
Established MS Teams channels (article)
8. Test against the sandbox environment first
As an API consumer, usually, you run tests against your functional requirements and also against your non-functional requirements (NFR) such as load tests, performance tests, penetration tests, etc.
As an internal or external business partner, you must perform such test also against our sandbox environment. For performing NFR tests in our sandbox environments, special rules and prerequisites apply.
Rules and prerequisites to test your application against our sandbox environment
For internal and external business partners, run your functional and NFR tests against our sandbox environment before finally running your application against our production environments.
NFR tests must be requested and agreed upfront through our established MS Teams channels.
NFR tests may only be performed on Fridays at the end of the business day (eob) according to the geographic region of the sandbox environment.
Explicit NFR tests against our sandbox environments are not allowed. In such cases, we can throttle the API responses.
See also
9. Run your application against an production environment
After you have tested your application against the sandbox environment and after your application has been finally released, you can consume APIs from the different production environments for your users regions.
Before releasing your application for a teamplay production environment, make sure that all pending subscriptions and registrations are already approved before. For manual approval steps, calculate at least three days after submitting your requests in advance!
See also
News on API changes and deployments (article)
What´s new in the Docs & guideline section (article)
10. Keep your application up to date
Over time, there might be changes in regard to the APIs that you call from your released application. Track API changes and schedule updates as early as possible to keep your application running based on the announcements about deprecated APIs.
Currently, the main channel to get information on deprecated APIs or API updates are the available MS teams channels. For details, refer to the article News on API changes and deployments.
After releasing and deploying your application to the production environments, you still remain the responsible owner of your application throughout the whole product lifecycle!
There might be in future e-mail notifications on deprecated APIs for your subscribed API products. Make sure that the e-mail address that you referenced during registration for your teamplay developer account is still valid and accessible in all cases - even if an employee has left your organization.
--------------- go to the top of this article --------------->>