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

Automated membership validity check for a customer

Only for partners with cash registers, member card scanners or input fields for the customer to enter his member number

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

Check TCS member number

[Base-URL]/membernumber/check/[member-number]

Validate the customers member number.

Returned JSON in case of a valid number:

{
    "success": true,
    "valid": true
}

Returned JSON in case of an invalid number:

{
    "success": true,
    "valid": false
}

Returned JSON in case of an error:

{
    "success": false,
    "error": "description of the error occurred"
}