Getting Started with API

Access Point: /api.1.1.0/ping.json

Description: Test if the API is working and you can connect it with your API Key and Division Name.



Success Response:


Error Response:

{"status":"<error value>","value":null}

Error values:

  • "api_key parameter expected": Parameter not received. You probably didn't add it into the call, or its name is wrong spelled.

  • "invalid api_key": The api_key param has a wrong format.

  • "api_key not found": There is not client with such API key in the division where you are calling (in this example, the division is The API key is wrong or you may call another URL (example: