For Stores / Businesses that have an EXISTING EPOS and want it linked with Beep via our API.
Overview
Beep will be in contact with your 3rd party epos provider and will supply tools and code needed for this epos provider to develop a plugin to be linked with the Beep System. This means that your current epos system will remain the same, the only difference will be that there will be extra features linking to Beep.
ATTENTION: This integration method does not imply any direct work from Beep Personnel on your 3rd Party ePOS software.
BeepXtra will supply the API tool, with all the support necessary to the existing ePOS provider in order to integrate the BeepXtra Service with your 3rd party ePOS software.
On completion of your purchase, please forward the following details related to your current ePOS provider to [email protected].
Current ePOS Provider Details Required:
- Company Name
- Contact Person
- Contact Tel Number
- Contact Email Address
Technical Specifications
The Beep API includes:
The Beep API consists of 2 parts.
- the RESTful API on our servers
- an SDK in PHP format for the public (This will eventually be encrypted before given out)
a) The RESTful API
The API accepts REST requests using the following methods:
- GET
- POST
- PUT
- DELETE
- HEAD
e.g. if the request is GET /card/9 it will automatically return the card details in JSON format for processing
b) The SDK part
The core part of the SDK is encrypted using ioncube Loaders.
Currently we have a PHP SDK and a .NET SDK
example files:
- sdk/beepsdk.php
- testapi.php
The beepsdk.php loads the API Class for usage in your software.
The testapi.php is an example of use so developers can expand on it and build their software.
In short, all you need to do is the following:
- define your configuration credentials ($appid, $appkey, etc)
- include the SDK file in your code
- perform requests using $beepapi->request('get', 'card', '9')
You will receive:
- Your Beep API ID
- Your API Security Key
- Documentation for developers
- Support during integration