Overview#
External API Action is a plugin belonging to Simpra POS. It is installed from the Simpra Marketplace and is used together with the Simpra Connect plugin.Purpose#
External API Action and Simpra Connect are plugins that allow 3rd party software developers to integrate with Simpra POS.Simpra Connect#
A plugin that enables use of the Simpra POS open API service. It can retrieve configuration information and check details from the property it belongs to, or perform basic operations on a check (adding items, applying discounts, adding payments, etc.).Reporting tools: data can be pulled through this plugin for reporting with BI tools
QR menu, menu board type applications can use it to get product and price information
3rd party applications can use it to create checks; needs such as sending orders from a mobile app or a website can be met
Delivery/takeaway applications can use it for integration; they can make or receive status changes such as preparing, on the way, delivered
3rd party applications can use it for menu and price update integration
3rd party companies can manage customer and customer discount processes
External API Action#
A plugin that allows 3rd party applications to perform check- and guest-specific operations in real time on the check currently being processed. Identifying information about the guest (QR code, phone number, membership number, etc.) is sent to the 3rd party application, and that application applies a benefit to the guest.1.
The guest's order is taken
2.
The information that the 3rd party application needs to uniquely identify the guest is requested (QR code, phone number, membership number, etc.)
3.
The check is locked on the cashier screen, and the check and guest information are sent to the 3rd party applicationThe application verifies the guest and, if eligible, applies a benefit (adds a discount or a payment to the check). At this stage, if needed, the guest can be given the option to choose from the mobile app (e.g. which discount right to use, or how much to pay from the balance)
The benefit is added to the check by the 3rd party application
The 3rd party application relays a message to the cashier, e.g. "Discount added", "100 TL payment added", "user not found", "insufficient balance"
The 3rd party application unlocks the check
4.
The cashier continues processing
Initial Setup - Authentication#
The Simpra Connect and External API Action plugins must be installed from the Simpra Marketplace. Both plugins generate their own token, and the permissions of these tokens differ."Simpra Connect" plugin settings:| Field | Description |
|---|
| Revenue Center | When a check is created via Simpra Connect, checks will be created under the selected revenue center |
| Print Template | When a custom menu item is created, determines which printer will be used |
| Receipt Print Template | If printing a receipt is requested when a subtotal is taken, the printer is selected here |
| Device | Checks opened via the API will be treated as opened with the device selected here |
| Sales Channel | Allows reporting checks opened via the API under a different sales channel |
| VAT | Selects the tax to be used for custom menu items added via the API |
| Menu Group | Selects the menu group to be used for custom menu items added via the API; the added item is thus reported under the desired group |
| Employee | Selects the staff member who will be considered to have opened the check; creating a dedicated user for the API is recommended |
| Payment Type | If a payment is sent via the API and none of the defined payment types is selected, this determines the type of payment added to the check |
Once setup is complete, the plugin's Access Key can be obtained from the same settings screen.
"External API Action" plugin settings:| Field | Description |
|---|
| Token | Generated automatically after setup; it will be sent in the simpra-action-token header field on requests. Can be used for security purposes |
| URL | The callback URL to be called when the check is locked |
| Lock Check | Determines whether the check will be locked after the request is sent to the specified URL. This is an operational decision; "yes" is chosen in most cases |
| Run Asynchronously | Determines whether the requests sent to the specified URL will be synchronous or asynchronous. This is an operational decision; "yes" is chosen in most cases |
For detailed scenario flows (payment, discount, add/cancel item, service charge, add note, unlock restriction), see the Scenarios section.Modified at 2026-07-30 10:14:49
