Admin API
👋 Who is this guide for?
This guide is for you as a shop owner using the Bonus System by PremSoft in your Shopware 6 store and wanting to understand how the system communicates with Shopware behind the scenes – for example, when saving bonus points or changing settings in the admin area.
🔍 What is the Admin API?
The Admin API is essentially the language that the Shopware admin panel (backend) uses to talk to the server. Every time you do something in the admin area – like assigning bonus points or changing a setting – it’s handled through this interface in the background.
The Bonus System by PremSoft also uses this API – immediately after installation, without requiring any manual setup.
⚙️ What does Shopware handle automatically?
The Bonus System by PremSoft includes its own data – such as bonus point logs, rule sets, or calculation settings. These data types are called entities.
Shopware automatically recognizes these entities and makes the following features available to you without any extra configuration:
✔️ View bonus data
You can view points and rules in the admin panel
✔️ Create new entries
You can manually assign points
✔️ Edit data
You can modify existing rules
✔️ Delete entries
You can remove data no longer needed
🔐 What do you need to keep in mind?
To fully use the Bonus System by PremSoft, your Shopware admin account needs the correct user permissions.
If you’re unable to save points or access certain settings, chances are that your user role is missing a required permission.
💡 In that case, go to User Roles in the admin and check if the appropriate rights for the Bonus System are enabled.
🧩 How exactly does the Bonus System use the Admin API?
Let’s say you save a new bonus point entry – in the background, this data is sent to a specific API endpoint (e.g., /api/bonus-points). You don’t need to do anything special – the Bonus System handles it for you.
You simply click "Save", and the Bonus System sends the data securely to the server – thanks to the Admin API.
🧪 Curious? A quick technical look
If you’re working with an agency or you’re just a bit tech-savvy:
The Admin API uses modern web standards (REST, JSON)
It’s only accessible for logged-in admin users
You can view all available endpoints at
/api/_info/swagger.htmlin your shop
The Bonus System by PremSoft fully relies on this infrastructure and adheres to Shopware standards.
If you want to use an external system to connect the Admin API, the following default methods are available for the Bonus System:
/api/_info/stoplightio.html#/schemas/PremsBonusSystemBonusProduct/api/_info/stoplightio.html#/schemas/PremsBonusSystemBooking/api/_info/stoplightio.html#/schemas/PremsBonusSystemCondition/api/_info/stoplightio.html#/schemas/PremsBonusSystemImportPoint/api/_info/stoplightio.html#/schemas/PremsBonusSystemUserPoint
✅ Your benefits as a shop owner
You don’t have to configure anything manually.
The Bonus System works right out of the box.
All actions like saving, editing, or displaying bonus data run smoothly via the Admin AP.
You get a clean, secure system for managing your bonus logic.
📌 Summary
The Bonus System by PremSoft uses the Shopware Admin API to communicate with your shop.
All key functions like creating, editing, and deleting bonus point entries happen seamlessly in the background.
If something isn’t working, checking the user permissions in the admin is often the solution.
The admin aPI can be used with external system to change data in Shopware.
Last updated
Was this helpful?