Free cash register

Kash.click, free online POS software since 2011

Learn more

Follow Us

Centre d’aide

L’aide, à portée de main

Comment pouvons-nous vous aider ?

Un réglage, une question, un geste du quotidien. Trouvez le bon guide et avancez simplement.

Recherchez un sujet ou décrivez ce que vous souhaitez faire.
For example :
← Accueil de l’aide

API / Web services

Create an account

Ancienne version maintenue pour les applications existantes. Pour une nouvelle intégration, utilisez la création avec identité et courriel confirmé. Documentation actuelle

It is possible to create an account programmatically, by providing an email address and the account name.

Cette API conserve son URL, ses paramètres et la réponse immédiate APIKEY / SHOPID pour les intégrations existantes. Dans l’interface, la création passe par Connexion, avec confirmation du courriel et rattachement à l’identité. Une création par API ne confirme pas le courriel et ne rattache pas automatiquement le compte à une identité.

Attention: you will need to validate your email via the link that will be automatically sent to you, otherwise your account may be deleted after a certain period of inactivity.

1) Create an account

Two methods:

  1. From the interface : On the Registration page
  2. By POST request : https://kash.click/workers/addShop.php

1.1 POST /workers/addShop.php

POST parameters

??????
email?Account email address
accountTitle?Account title (name of the institution)
configType??Default dataset ('Bar', 'Ticket-Office', 'Butchery-Delicatessen', 'Bakery', 'Brewery', 'Tobacconist', 'Cafe', 'Camping', 'Liquor-Shop', 'CBD', 'Coffee-shop', 'Coiffeur', 'Shops', 'Street-trade', 'Grocery-store', 'Florist', 'Food-truck', 'Cheese-shop', 'Beauty-institute', 'Library', 'Clothing-store', 'Market', 'Pharmacy', 'Pizzeria', 'Fish-shop', 'For-association', 'Dry-cleaning', 'Restaurant', 'Fast-food', 'Supermarket', 'Perfumery', 'Services', 'Ecommerce', 'Solana', 'ChatGPT', 'Claude', 'Prestashop', 'VivaWallet', 'SumUp', 'GoCardless', 'Sunmi', 'Yavin', 'Pennylane')
data[companyRegistrationNum]??Company registration number (RCS)
data[taxRegistrationNum]??????
data[adressline1]??Address line 1
data[postCode]????
data[city]???
data[country]??Country
data[lat]??lat
data[lng]??lng
data[phone]????
data[urlwebsite]??URL of your website (external)
data[defaultAccountingChapter]??Default accounting chapter
data[pdffooter]??Footer text for PDF invoices
data[paymentDueDays]??Délai de paiement en jours (0 = comptant)
data[recoveryFeeAmount]??Montant de l’indemnité pour frais de recouvrement (0 = aucune)
data[recoveryFeeCurrency]??Devise de l’indemnité (code à 3 lettres)
data[latePenaltyMode]??Pénalités de retard : ecb_plus_10, fr_legal_x3 ou custom
data[latePenaltyRate]??Taux annuel personnalisé des pénalités (%)
data[earlyPaymentDiscountRate]??Taux d’escompte pour paiement anticipé (%) (0 = aucun)
data[earlyPaymentDiscountDays]??Délai d’escompte en jours (0 = à l’émission de la facture)
data[receiptHeader]??Ticket header
data[receiptFooter]??Ticket footer
data[defaultVatID]??Default VAT rate identifier
data[currency]????
data[language]??Language
data[pricesAreProvidedTaxIncluded]??0 = Prices are entered excluding VAT; 1 = Prices are entered including VAT
data[paypalAddress]??Your PayPal email address (for collecting payments)
data[deliv_tablePlan]??Table management
data[deliv_takeAway]??Takeaway
data[deliv_drivethru]??Drive thru
data[deliv_deliver]??Delivery management
data[deliv_bar]??Counter sales
data[deliv_relayDeposit]??Delivery to a collection point
data[deliv_default]??Default delivery method
data[receipt_showVat]??Display VAT on tickets
data[receipt_showShopName]??Display the shop name on the tickets
data[receipt_showCashbox]??Display the cashier's name on the receipts
data[receipt_showSeller]??Display the seller's name on the tickets
data[receipt_showClient]??Display the customer's name on the tickets
data[receipt_showAddress]??Display the store's contact details on the tickets
data[receipt_showCompanyRegistrationNum]??Display the store's company number on the receipts
data[receipt_showClientSurname]??Display the customer's first name on the tickets
data[receipt_showClientAddress]??Display the customer's address on the tickets
data[receipt_showClientPhone]??Display the customer's phone number on the tickets
data[receipt_showGlobalVat]??Display the general VAT on the tickets
data[receipt_showComment]??Show ticket comments
data[receipt_showPricesBeforeTaxes]??Display prices excluding VAT on tickets
data[orderRequires_deliveryChoice]??Choosing a delivery method is mandatory for each order.
data[orderRequires_name]??The customer's name is required for each order.
data[orderRequires_surname]??The customer's first name is required for each order.
data[orderRequires_address]??The customer's address is required for each order.
data[orderRequires_email]??Customer email address is required for each order
data[orderRequires_phone]??Customer phone number is required for each order
data[orderRequires_date]??Choosing a date is mandatory for each order.
data[orderRequires_CompanyRegistrationNum]??The customer's company number is required for each order.
data[orderRequires_comment]??Comment required for each order
data[enable_stock]??Activate inventory management
data[enable_barcodes]??Enable barcode handling
data[enable_departments]??Activate shelf management
data[enable_departmentsGroups]??Enable shelf group management
data[enable_credits]??Enable asset management
data[enable_descriptionsForItems]??Enable descriptions for items
data[enable_variations]??Enable variation management
data[enable_delivShop]??Activate deliveries with Deliv.shop
data[enable_relayDeposit]??Enable pickup point management
data[enable_descriptionForVariations]??Enable descriptions for items
data[enable_dateOfConsumption]??Enable expiration date management
data[enable_coupons]??Enable coupon management
data[enable_weightForItems]??Enable item weight management
data[enable_whiteLabel]??Enable white labeling (note: cannot be disabled)
data[whiteLabelAdminUserID]??White label administrator user ID
data[isWebShopEnabled]??Activate the webshop
data[webShopURL]??Webshop URL
data[webShopLang]??Webshop language
data[webShopCol1]??Background color 1
data[webShopCol2]??Background color 2
data[webShopCol3]??Background color 3
data[webShopColT1]??Text color 1
data[webShopColT2]??Text color 2
data[webShopColT3]??Text color 3
data[prestaShopApiKey]??Prestashop API key
data[prestaShopURL]??Your Prestashop URL
data[saleWebhookURL]??Webhook URL for sales
data[openingWebhookURL]??Webhook URL for cashbox closures
data[enableYavin]??Enable Yavin payment collection
data[yavinSecret]??Secret code
data[yavinSerial]??yavinSerial
data[enableVivaWallet]??Activate payment collection with Viva.com
data[vivaWalletMerchant]??Viva.com Merchant ID
data[vivaAccoundID]??Viva.com account ID
data[whiteLabelManagerSet]??If data[whiteLabelManagerSet]='fromSecret', then it is also possible to provide the parameter $data["whiteLabelManagerSecret"] to assign an existing manager to the account; If data[whiteLabelManagerSet]='new', then it is also possible to provide the parameters $data["whiteLabelData"]["nom"],$data["whiteLabelData"]["rcs"],$data["whiteLabelData"]["vat"],$data["whiteLabelData"]["addressLine1"],$data["whiteLabelData"]["addressLine2"],$data["whiteLabelData"]["codePostal"],$data["whiteLabelData"]["ville"],$data["whiteLabelData"]["pays"],$data["whiteLabelData"]["telephone"],$data["whiteLabelData"]["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": "Error sending email"
}

JavaScript example (fetch)

const email = "mon.email@example.com";
const accountTitle = "My Shop";

fetch("https://kash.click/workers/addShop.php", {
  method: "POST",
  headers: { "Content-Type": "application/x-www-form-urlencoded" },
  body: new URLSearchParams({ email, accountTitle })
})
  .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

Spécification OpenAPI de cette ancienne version

Spécification OpenAPI de cette ancienne version

Les nouvelles clés délivrées par authentification ou création de boutique sont des clés gérées, sans expiration et avec toutes les autorisations. Elles apparaissent dans Configuration → Webservices → Clés API et peuvent ensuite être limitées ou révoquées. Les anciennes clés déjà utilisées restent valides.

Essayer gratuitement

This document is made available under the terms of the licence Creative Commons Attribution 4.0 International (CC BY 4.0).