API reference
The tebio business portal offers REST API services for the integration of external systems. This includes, among other things, subscription management, payment processing, voucher management and the management of external partner products.
All services are provided as REST APIs in OpenAPI format (ecobc_openapi.json or ecobc_openapi.yaml) and can be tested directly via the integrated API documentation.
When do I need this function?
Section titled “When do I need this function?”Use the API reference if you:
- Want to integrate external systems (such as ERP, CRM, web shops) with tebio.
- Need detailed information about endpoints, HTTP methods, payload structures, and possible error codes.
- Want to execute test requests (
Try it out) directly in the browser to test the behavior of the API.
Requirements
Section titled “Requirements”[!IMPORTANT] For security reasons, the detailed API reference is not publicly visible. Access is only possible for logged in and registered users of the tebio business portal.
You also need an active API key if you want to test the endpoints using the reference’s interactive mode.
Open API reference
Section titled “Open API reference”- Log in to the tebio business portal with your user data.
- Navigate to the Developer area using the terminal icon (top right).
- Click on the Documentation tab (Documentation or API Reference, depending on the name in your portal).
- You will now see the interactive OpenAPI interface in which all available API areas (such as
Billing,Client,Customer,Order,Payment, others) are listed in a structured manner.
Result
Section titled “Result”The API reference opens. There you can view available endpoints, methods, request and response structures and error codes.