The newest version of this document can be found online at: https://resources.apnet.ch/api/manage/cash-registers
Last modified: 2021-07-12 17:44 ➔ reload

Automated management of cash registers

Only for partners with an API integration at the level of the cash registers

API basics

• Base-URL: https://[dev|test|www].pluscash.ch/api/manage/authentication/[api-key]/[partner-id]/
• Environments: As pronounced above there are three environments available.
  • https://dev.pluscash.ch is our development environment. If you have new / other requirements to this API, then individual features and changes are developed on this environment.
  • https://test.pluscash.ch is our testing environment. Please test your implementation to already documented features here.
  • https://www.pluscash.ch is the productive environment.
• Encoding: All data is UTF-8 encoded (input and output)!
• POST data delivery:
  • Type "multipart/form-data" with only one key / value pair, where the key named "data" and its value is a JSON string.
  • Type "application/json" with a POST body only consisting of a JSON string.
• uuid: All uuids must be unique on your system. You don't have to care about uniqueness inside the apNet systems.
• api-key and partner-id: Those two values are delivered to you by apNet, once your company is registered at apNet.
• Debugging helper: If you're sending POST data but our system is not recognizing it you can attach the following GET parameter(s) to the API URL and then see what data our system recieves:
  • display-post-data displays the received POST "multipart/form-data" data in form of an array. If you sent the data with type "application/json" and our system was able to read / interpret it it is automatically mapped to the array we would expect with "multipart/form-data". If this array is displayed empty, our system then displays the raw POST input data for you to debug.
  • as-html displays the output of display-post-data as human readable HTML.
• TCS member number for testing: An active and valid TCS member card, including member number and barcode, can be fount online at: https://resources.apnet.ch/tcs/member-card.jpg

API methods

Get Cash-Registers

[Base-URL]/cash-register/get

Returns all cash-registers attached to your partnerID.

Returned JSON:

{
    "success": true,
    "devices": [{
        "device": "MUHA-001",               // device identifier, defined when adding a new cash-register
        "note": "Musterhausen, Kasse 1",    // note, defined when adding a new cash-register
        "locationId": "LOC-001",            // id of your location, set via location API
        "locationZip": "1234",              // zip of location
        "locationAddress": "Mustergasse 13" // address of location
    }, {
        ...
    }]
}

Returned JSON in case of an error:

{
    "success": false,
    "message": "[error-message]"
}

Add or Update a Cash-Register

[Base-URL]/cash-register/add

Adds a new cash-register (or updates, if submitted device ID already exists).

Required POST data:

{
    "device": "MUHA-001",               // [required], defined by you
    "note": "Musterhausen, Kasse 1",    // [required], defined by you, note which helps to identify the device
    "locationId": "LOC-001",            // [required if no locationZip/locationAddress submitted], ID of location, defined by you via location API
    "locationZip": "1234",              // [required if no locationId submitted], ZIP of location where you want to attach the device
    "locationAddress: "Mustergasse 13"  // [required if no locationId submitted AND if you have multiple locations with the same ZIP]
}

Returned JSON:

{
    "success": true,
    "message": "new device created"     // or "device updated", if device has already existed
}

Returned JSON in case of an error:

{
    "success": false,
    "message": "[error-message]"
}

Disable a Cash-Register

[Base-URL]/cash-register/disable

Disables a cash-register. It is no longer possible to book transactions on this device.

Required POST data:

{
    "device": "MUHA-001"             // [required], defined by you
}

Returned JSON:

{
    "success": true,
    "message": "1 devices disabled"  // returns number of affected devices
}

Returned JSON in case of an error:

{
    "success": false,
    "message": "[error-message]"
}