Centre d'aide
Cette aide est disponible pour vous guider dans l'utilisation de notre logiciel de caisse
Rechercher par mot clé dans l'aide :
Authentification
L'accès à l'API nécessite de fournir votre APIKEY et SHOPID.
Résumé rapide : Obtenez un token (APIKEY) + l’identifiant de boutique (SHOPID), puis utilisez-les pour télécharger vos données ou enregistrer des ventes.
1) Obtenir un auth token
Différentes méthodes :
- Depuis l’interface : Configuration ? Webservices (le token de votre compte y est affiché).
- Via OTP :
https://kash.click/workers/getOTPForAccount.php - Par requête POST :
https://kash.click/workers/getAuthTokenWithPassword.php
1.1.1 POST /workers/getOTPForAccount.php
Ce endpoint vous permet d'obtenir par email le mot de passe à usage unique (OTP), que vous pouvez utiliser afin d'obtenir la clé API de votre compte
Paramètres POST
| Nom | Obligatoire | Description |
|---|---|---|
email | Oui | L'email votre compte |
accountID | Non | L'identifiant interne du compte |
Réponse JSON attendue (succès)
{ "success": true, "result": "Email with OTP has been sent", "consumeOTPlink": "[the link to use in order to consume the OTP]"} Réponse JSON attendue (échec)
{ "success": false, "result": "Error sending email"} Exemple JavaScript (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
Ce endpoint vous permet d'obtenir la clé API de votre compte grace au mot de passe à usage unique (OTP) que vous avez reçu par email suite à l'appel de getOTPForAccount.php
Paramètres POST
| Nom | Obligatoire | Description |
|---|---|---|
email | Oui | L'email votre compte |
otp | Non | Le One Time Password que vous avez reçu par email |
Réponse JSON attendue (succès)
{ "success": true, "result": "Here are your credentials", "APIKEY": "[votre Token]", "SHOPID": "[identifiant de compte boutique]"} Réponse JSON attendue (échec)
{ "success": false, "result": "OTP not found"} Exemple JavaScript (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
Ce endpoint vous permet d'obtenir la clé API de votre compte grace à votre mot de passe et identifiant.
Veuillez favoriser le endpoint getOTPForAccount.php sur un environnement public, ou distant.
Paramètres POST
| Nom | Obligatoire | Description |
|---|---|---|
login | Oui | Le login de votre compte existant |
password | Oui | Le mot de passe de votre compte existant |
Réponse JSON attendue (succès)
{ "success": true, "result":"Here are your credentials", "APIKEY": "[votre Token]", "SHOPID": "[identifiant de compte boutique]"} Réponse JSON attendue (échec)
{ "success": false, "result": "Authentication error"} Exemple JavaScript (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) Avec la clé API, vous pouvez…
- Télécharger vos données de ventes
- Télécharger articles, clients, rayons, etc.
- Enregistrer des ventes
Ce document est mis à disposition selon les termes de la licence Creative Commons Attribution 4.0 International (CC BY 4.0) .