Free cash register

Kash.click, free online POS software since 2011

Follow Us

Help Center

This help will guide you through the setup and usage of our point of sale cash register software.

Search by keyword in the help section:

Authentication

Accessing the API requires providing your APIKEY and SHOPID.

Quick summary: Get a token (APIKEY) + the shop ID (SHOPID), then use them to upload your data or record sales.

1) Get an auth token

Different methods:

  1. From the interface : Configuration ? Webservices (your account token is displayed there).
  2. Via OTP : https://kash.click/workers/getOTPForAccount.php
  3. By POST request : https://kash.click/workers/getAuthTokenWithPassword.php

1.1.1 POST /workers/getOTPForAccount.php

This endpoint allows you to receive a one-time password (OTP) via email, which you can use to obtain your account's API key.

POST parameters

NameNecessaryDescription
emailYesYour account email
accountIDNoThe account's internal identifier

Expected JSON response (success)

{ "success": true, "result": "Email with OTP has been sent", "consumeOTPlink": "[the link to use in order to consume the OTP]"}

Expected JSON response (failure)

{ "success": false, "result": "Error sending email"}

JavaScript example (fetch)

const email = "mon.email@example.com";fetch("https://kash.click/workers/getOTPForAccount.php", { method: "POST", headers: { "Content-Type": "application/x-www-form-urlencoded" }, body: new URLSearchParams({ email })}) .then(r => r.json()) .then(data => {  if (data.success) {   console.log("Now provide OTP using :", data.consumeOTPlink);  } else {   console.error("Auth error", data);  } });

1.1.2 POST /workers/getAuthTokenWithOTP.php

This endpoint allows you to obtain your account's API key using the one-time password (OTP) you received by email after calling getOTPForAccount.php

POST parameters

NameNecessaryDescription
emailYesYour account email
otpNoThe One Time Password you received by email

Expected JSON response (success)

{ "success": true, "result": "Here are your credentials", "APIKEY": "[your token]", "SHOPID": "[shop account ID]"}

Expected JSON response (failure)

{ "success": false, "result": "OTP not found"}

JavaScript example (fetch)

const email = "mon.email@example.com";fetch("https://kash.click/workers/getAuthTokenWithOTP.php", { method: "POST", headers: { "Content-Type": "application/x-www-form-urlencoded" }, body: new URLSearchParams({ email })}) .then(r => r.json()) .then(data => {  if (data.success) {   console.log("Token:", data.APIKEY);   console.log("Shop:", data.SHOPID);  } else {   console.error("Auth error", data);  } });

1.2 POST /workers/getAuthTokenWithPassword.php

This endpoint allows you to obtain your account's API key using your password and username.

Please favor the getOTPForAccount.php endpoint in a public or remote environment.

POST parameters

NameNecessaryDescription
loginYesYour existing account login
passwordYesYour existing account password

Expected JSON response (success)

{ "success": true, "result":"Here are your credentials", "APIKEY": "[your token]", "SHOPID": "[shop account ID]"}

Expected JSON response (failure)

{ "success": false, "result": "Authentication error"}

JavaScript example (fetch)

const login = "mon.email@example.com";const password = "myPassword";fetch("https://kash.click/workers/getAuthTokenWithPassword.php", { method: "POST", headers: { "Content-Type": "application/x-www-form-urlencoded" }, body: new URLSearchParams({ login, password })}) .then(r => r.json()) .then(data => {  if (data.success) {   console.log("Token:", data.APIKEY);   console.log("Shop:", data.SHOPID);  } else {   console.error("Auth error", data);  } });

2) With the API key you can…

  • Download your sales data
  • Download items, customers, departments, etc.
  • Record sales
Register now
Licence Creative Commons This document is made available under the terms of the licence Creative Commons Attribution 4.0 International (CC BY 4.0) .