External System Calls are functions that allow Korona to execute certain functions outside the scope of the software. You can have Korona call up a website, third party appointment booking site, or utilize a loyalty program with its own API.
For information in regards to setting up your API with Korona, please visit our KORONA.pos Client API Manual Page.
Creating External System Calls
Begin by navigating to Settings > External System Calls. Once you are at the screen, click on the +New button to create an External System Call.
On this screen you will have the following options to create your system call:
Number: The unique number for your system call.
Name: The name for your system call.
Display URL: The URL that will be loaded in the POS Web browser.
POST (Request Data): This allows you to choose if the request-data should be transferred by HTTP-POST (JSON) to display-URL. Otherwise, it will perform just an HTTP-GET-request without any request-data
System URL: This is a call made by the pos w/o opening the Web Browser. This is used for API calls. For more information, please visit our API manual page.
Customer Display URL: This would be for if a call should display results on the Customer Display instead of the main Cashier Facing display as in Display URL
Login: Sets the optional login for the HTML authentication.
Password: Sets the optional password for the HTML authentication.
Connect Timeout (ms): Sets the optional connection timeout for the system URL in milliseconds.
Request Timeout (ms): Sets the optional read timeout for the system URL in milliseconds.
Create your system call by giving it a name, and setting the proper parameters as needed. In this case, we will be accessing an email account that cashiers frequently check.
Once you have configured your system call, click on the Save button at the top of the screen.
*Note: The create method can be used, among other things, for voucher creation in third-party systems via API. The voucher can be posted normally and is automatically activated when the document is closed and printed by the confirmation.
Adding the function to the POS Terminal
Now you will need to add the function to the point of sale. Alternatively, you can use the POS Profile if you need this to happen at a certain point of the transaction. For this example, we will be calling the function at the terminal.
Go to the Button Configurations screen by navigating to Settings > Button Configurations. Select the button layout that you wish to add the button to. Right-click on an empty square and select “Select External System Call” the Type should be already selected for you. From the following drop-down menu choose Email Access and click Add. As that was the external system call we created with the URL for our Email. Once you have finished adding the button, click on the Save button at the top of the screen.
For detailed information on creating buttons for the POS Terminal, please visit our Create POS Buttons / Button Configuration manual page.