api-documentation/README.md

20 lines
1.1 KiB
Markdown

# API Documentation for TyrePro
The documentation follows the [OpenAPI 3.0.0 specifications](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md). You can read the YAML files manually or use any editor like [Swagger](https://editor.swagger.io/) or similar.
## Getting Started
Explore the endpoints of the common.yaml file! There you will find some general points and ways to create a session. Explore the other YAML files to check which permissions (sessions) you need, and let's get started!
## API Stability
The API undergoes frequent updates and improvements to provide the best service and stay current. We encourage you to follow our Git repository for updates.
## Pricing
We've charging plans dependant on your usage requirements. If you have doubts, please contact us and explain your goals and what you want to achieve. Special requirements or endpoints will be charged for customization on a per-hour basis.
## Have More Questions?
Feel free to visit our [homepage](https://prm-ag.de) and reach out to us with any questions or inquiries!