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:
List of accounts
Confirmez votre adresse de courriel avant de consulter les comptes qui lui sont associés. Aucune liste n’est fournie à partir du seul courriel.
1) Recevoir le code de confirmation
Envoyez email par POST à /workers/getOTPForAccount.php. La réponse générique contient challengeId et expiresIn: 600, sans information sur les comptes. Le code reçu par courriel est valable dix minutes et cinq essais au maximum.
Le paramètre accountID est facultatif. Si vous le renseignez lors de la demande de code, la confirmation reste limitée à ce profil.
2) Confirmer et lister les comptes
POST /workers/listShops.php
| Naam | Verplicht | Beschrijving |
|---|---|---|
email | Ja | Adresse de courriel à confirmer |
challengeId | Ja | Référence de 32 caractères hexadécimaux reçue lors de la demande |
otp | À la confirmation | Code de six chiffres reçu par courriel |
emailProof | Après confirmation | Preuve retournée après confirmation, à transmettre à la place du code |
accountTitle | Neen | Filtre sur le nom du compte, appliqué après confirmation |
Un courriel seul reçoit email_confirmation_required (HTTP 401). Une confirmation valide consomme le code et retourne cette enveloppe :
{ "success": true, "accounts": [{ "accountID": "123", "accountTitle": "Ma boutique" }], "emailProof": "<64 caractères hexadécimaux>", "expiresIn": 300}La preuve expire après cinq minutes au maximum, sans prolongation. Elle permet de consulter de nouveau la liste puis de demander une clé pour un profil choisi. Une adresse confirmée sans compte reçoit une liste vide.
const response = await fetch('/workers/listShops.php', { method: 'POST', headers: { 'Content-Type': 'application/x-www-form-urlencoded' }, body: new URLSearchParams({ email, challengeId, otp })});const confirmed = await response.json();// Afficher confirmed.accounts pour choisir le profil.// Garder confirmed.emailProof seulement pour terminer cette demande.3) Obtenir la clé du profil choisi
Envoyez email, challengeId, emailProof et accountID par POST à /workers/getAuthTokenWithOTP.php. Seul un profil administrateur actif peut recevoir la clé complète de l’établissement. La preuve est consommée une seule fois lors de la délivrance. La réponse contient APIKEY et SHOPID, jamais un cookie de connexion.
La liste des profils après confirmation du courriel ne donne pas le droit d’obtenir une clé. Un collaborateur reçoit api_admin_required (HTTP 403). Demandez à un administrateur une clé dédiée dans Configuration → Webservices → Clés API, avec les seules autorisations nécessaires. Les clés déjà émises restent valides.
Un profil protégé par une identité ou un second facteur doit utiliser la connexion interactive et une clé API dédiée. Les accès suspendus ou révoqués, les établissements fermés et les webservices désactivés ne permettent pas de délivrer une nouvelle clé.
This document is made available under the terms of the licence Creative Commons Attribution 4.0 International (CC BY 4.0) .