Playground
The tebio Playground is a public test environment. Here you can test various API services without changing productive customer data or having to configure your own setup.
When do I need this function?
Section titled “When do I need this function?”Use the Playground if you:
- Want to program and test new integrations (e.g. payments or customer creation) before using them productively.
- Want to familiarize yourself with the data structures and payloads of the tebio API.
- Try out the endpoints documented in the API reference live (“Try it out”) without having any impact on productive data.
Requirements
Section titled “Requirements”In contrast to productive clients, you do not need your own access data for the Playground. The playground is preconfigured so that you can start immediately.
This is how the playground works
Section titled “This is how the playground works”The Playground is based on a public, restricted setup. You simply use the following predefined authentication and mapping data for your API calls:
- Public API key:
demo-1518-452d-b6d8-4d47db61b9eb - Predefined Client:
a1b2c3d4 - Predefined client:
ten1b2c3
Note: In our web-based API reference, many example data fields are already preset with exactly these values. This means you can try out the services immediately without having to manually collect IDs.
Supported test scenarios
Section titled “Supported test scenarios”The Playground sample data is specifically designed to be able to test the following API calls directly without further configuration:
Basic management:
- Retrieve a client
- List api keys
- List tenants
Customers and Sales:
- Search customers
- Search sales partners
Documents and webhooks:
- List document types
- Search document types
- Create eventType setting
- Search Webhook endpoints
Payments and vouchers:
- List payment methods
- Get voucher info (simplified) (get voucher information). Note: There is a reusable test voucher with the code
ABCDEFGHIJKand a value of EUR 1.99. - Start payment: You can simulate fictitious payments based on the above test voucher (
ABCDEFGHIJK).
Identification:
- Create EID transaction
Data cleaning (cleanup)
Section titled “Data cleaning (cleanup)”Since the Playground is a public test environment, the system automatically ensures a clean state.
[!NOTE] Any new entities and data you create (for example, new test customers or transactions), as well as any changes to existing data, are automatically undone (cleaned) every night. So don’t rely on test data created today still being available tomorrow.
Result
Section titled “Result”You can test API endpoints in the Playground without changing production data. Note that test data is cleaned regularly.