The chat responses are generated using Generative AI technology for intuitive search and may not be entirely accurate. They are not intended as professional advice. For full details, including our use rights, privacy practices and potential export control restrictions, please refer to our Generative AI Service Terms of Use and Generative AI Service Privacy Information. As this is a test version, please let us know if something irritating comes up. Like you get recommended a chocolate fudge ice cream instead of an energy managing application. If that occurs, please use the feedback button in our contact form!

Provide Feedback

Feedback sent

Thank you for your feedback!

Provide Feedback

Please log in to provide feedback
Skip to content
Siemens Xcelerator Marketplace

API Guidelines

These are general API guidelines RECOMMENDED for all Siemens developers working on internal and external APIs, as well as for our customers, partners, and anyone consuming or working with our APIs.

These guidelines MUST be applied to Siemens Xcelerator X products and solutions. Project teams MAY enhance these guidelines with additional restrictions based on their business needs, but we generally recommend that the guidelines listed here are still adhered to.

The goal of these guidelines is to help developers design simple, consistent, and easy-to-use APIs that can be easily consumed by API clients. API designers and integrators can focus on quickly providing value while avoiding the headache of trying to solve common API design or system integration problems.

The Siemens API guidelines are split into common and technology-specific parts.

  • The Common API Guidelines cover topics relevant to all APIs regardless of technology, such as documentation, versioning, or lifecycle phases.
  • The REST API Guidelines provide information specific to REST APIs, such as response structure, resource representation, or status codes.
Contact us