API & documentation

Une seule clé. Chaque module.

La plupart des logiciels professionnels vous donnent une API par produit — une pour la caisse, une autre pour le stock, une troisième pour les factures, chacune avec sa propre authentification et sa propre gestion des dates. Kardopal en a une. La même clé, la même URL de base et la même grammaire de requête accèdent à 129 ressources réparties sur 29 modules.

Créer une clé API Découvrez ce qu'il atteint
29
Modules
129
Ressources
1
Clé, une URL de base
200
Lignes par page, max

Pourquoi cette API mérite d'être développée

Six choses qui sont vraies ici et qui ne le sont généralement pas.

Il se décrit lui-même

Appelez l'URL de base et l'API renvoie son propre catalogue — chaque module que votre clé peut voir, chaque ressource qu'il contient, quels champs sont recherchables et lesquels sont filtrables. Vous n'avez pas besoin de cette page pour écrire l'intégration ; vous en avez besoin pour décider de le faire.

Des permissions qui contrôlent réellement

Les scopes, les routes et les pastilles de permission dans l'application sont générés à partir d'une seule liste, de sorte qu'une permission ne peut être offerte que s'il y a un endpoint derrière. Une clé limitée à articles obtient des articles — lui demander la paie renvoie 403, pas une page vide silencieuse.

Une seule grammaire de requête, partout

recherche, depuis, jusqu'à, passer et prendre signifient la même chose sur les factures que sur les mouvements de stock. Apprenez la structure une fois et chacune des 133 ressources y répond.

Votre instance, et uniquement la vôtre

Chaque table contient un identifiant de locataire et chaque requête est limitée au locataire de la clé avant d'atteindre la base de données. Il n'y a pas de lecture inter-locataires susceptible d'être erronée, car il n'existe aucun paramètre pouvant en demander une.

Les champs restent cohérents

La liste des champs est lue à partir du schéma en direct au démarrage plutôt que maintenue manuellement. Une nouvelle colonne apparaît d'elle-même ; une colonne supprimée ne peut jamais laisser de référence orpheline dans la documentation ou provoquer une erreur 500 au premier appel.

Lecture seule, délibérément.

Les clés lisent ; elles n'écrivent jamais. Une intégration défectueuse ne peut pas annuler une facture ou déplacer du stock. Tout ce qui modifie un enregistrement passe par l'application ou une connexion du personnel, où il est attribué à une personne et consigné dans le journal d'audit.

Démarrer en une seule requête

Tout est un GET. Si vous pouvez utiliser curl, vous pouvez l'utiliser.

GET /api/v1L'intégralité du catalogue visible par votre clé
curl https://api.kardopal.com/api/v1 \
  -H "X-API-Key: kp_live_…"
GET /api/v1/meSonde de vérification — à qui appartient cette clé, et que peut-elle lire
{
  "authType": "api_key",
  "tenant": { "name": "Nova Retail", "plan": "pro" },
  "scopes": ["items", "sales", "pos"]
}
GET /api/v1/items?search=lamp&take=2Toute ressource, même format
{
  "resource": "items",
  "scope": "items",
  "total": 41,
  "skip": 0,
  "take": 2,
  "hasMore": true,
  "data": [ { "id": "…", "name": "Desk Lamp LED" } ]
}
GET /api/v1/meta/countsNombre de lignes par ressource — voyez quelles données existent réellement
curl https://api.kardopal.com/api/v1/meta/counts \
  -H "X-API-Key: kp_live_…"

Les cinq paramètres

ParamètreFonctionnalitésNotes
rechercheCorrespondance insensible à la casse sur les champs recherchables de la ressourceLes champs concernés sont listés dans /meta
depuisUniquement les enregistrements à partir de cette dateS'applique au champ par lequel la ressource est triée
jusqu'àSeuls les enregistrements jusqu'à cette dateCombiner avec depuis pour une fenêtre
passerDécalage dans le jeu de résultats.Par défaut à 0
prendreNombre de lignes à retournerPar défaut 50, plafonné à 200

Les ressources acceptent également des filtres de correspondance exacte sur leurs propres champs déclarés — ?statut=payé, ?warehouseId=… — et chacun indique lesquels sont ceux-là. Chaque réponse de liste contient total et aPlus, pour que la pagination soit une boucle, pas une estimation.

Portée de l'API

29 modules, 129 ressources. Chaque carte est une permission que vous pouvez accorder à une clé — et l'étiquette grise indique où se trouvent les mêmes enregistrements dans l'application sur votre téléphone.

Contacts

2

Clients, fournisseurs et leurs segments.

contactssegments de contact
contacts Contacts

Articles

7

Le catalogue : produits, variantes, marques, listes de prix et unités.

articlescatégoriesmarquesvariantes d'articleslistes de prixunités+1 de plus
articles Articles

Inventaire

7

Entrepôts, niveaux de stock, mouvements, lots, numéros de série et emplacements.

entrepôtsstock-movementsniveaux-de-stocklotsnuméros de sériecomptages-de-stock+1 de plus
inventaire Inventaire

Ventes

7

Factures, devis, commandes, avoirs et paiements.

facturesdeviscommandes clientsavoirspaiementsfactures-récurrentes+1 de plus
ventes Ventes

POS

11

Caisses, équipes, reçus, tables et chaque vente passée au comptoir.

ventes-posroulements-posterminaux-posutilisateurs-postables-poszones-de-table-pos+5 de plus
pos POS

CRM

4

Prospects, affaires, pipelines et propositions.

prospectsoffrespipelinespropositions
crm CRM

Achat

5

Commandes d'achat, demandes, retours, factures et paiements fournisseurs.

bons-de-commandedemandes-d'achatretours-achatsadditionspaiements-fournisseurs
achat Achat

Comptabilité

5

Dépenses, comptes bancaires, transactions et taux d'imposition.

dépensescatégories-de-dépensescomptes-bancairesbank-transactionstaux-d'imposition
comptabilité Comptabilité

Marketing

4

Campagnes, destinataires, pages de destination et soumissions de formulaires.

campagnesdestinataires-de-campagnepages de destinationsoumissions de formulaires
marketing Marketing

HR

8

Personnel, départements, congés, fiches de paie, présence et recrutement.

employésdépartementsleave-requestsfiches de paiePrésencesoffres-d'emploi+2 autres
hr HR

Feuille de temps

2

Saisies de temps et les projets auxquels elles sont imputées.

entrées-de-tempsProjets de feuille de temps
feuille de temps Feuille de temps

Projets

3

Projets, phases et leurs coûts associés.

projetsproject-phasescoûts-de-projet
projets Projets

Réservation

3

Rendez-vous, services réservables et le personnel qui les fournit.

réservationsServices de réservationpersonnel-de-réservation
Réservation Réservation

Service sur site

7

Interventions, techniciens, ordres de travail, contrats et équipement.

tâches-sur-le-terraintechniciensdemandes de servicecontrats de servicebons-de-travailfiches-de-travail+1 de plus
service_sur_site Service sur site

Logistique

5

Expéditions, chauffeurs, véhicules, zones et transporteurs.

expéditionslivreursvéhiculeszones-de-livraisonTransporteurs
logistique Logistique

Service d'assistance

5

Tickets, politiques SLA, articles d'aide et la base de connaissances.

ticketstickets-clientsarticles-d'aidebase-de-connaissancespolitiques-sla
assistance Service d'assistance

Après-vente

5

Retours, réclamations de garantie, réparations et enregistrements de produits.

RMAdemandes-de-garantieenregistrements de garantieréparationsenregistrements-produits
après-vente Après-vente

Location

3

Actifs louables, contrats de location et leurs lignes.

actifslocationslignes de location
location Location

Restaurant

2

Le menu et les commandes passées.

articles-du-menucommandes de menu
restaurant Restauration

File d'attente

5

Tickets, services, comptoirs, succursales et écrans d'affichage.

tickets de file d'attenteservices de file d'attentecompteurs-de-file-d'attentebranches de file d'attenteécrans-de-file-d'attente
file d'attente File d'attente

Fidélité

6

Membres, comptes, niveaux, récompenses et transactions de points.

loyalty-memberscomptes-fidélitérécompenses-fidéliténiveaux-de-fidélitétransactions-fidélitéloyalty-coupons
fidélité Fidélité

Emplacements

2

Sites et succursales.

emplacementssuccursales
emplacements Emplacements

IOT

6

Appareils, sites, boîtiers, alertes, événements et contenu d'affichage.

iot-devicesiot-sitesalertes-iotiot-eventsboîtiers IoTcontenu-affichage-iot
iot Hub IOT

Studio IA

3

Actifs générés, les projets qui les contiennent et l'historique des tâches.

actifs-iaprojets d'IAai-jobs
ai_studio Studio IA

Commerce

3

Membres du réseau, demandes de devis et encaissements.

membres-du-réseaudemandes-de-deviscollections
commerce Commerce

Signature électronique

2

Demandes de signature et les signatures recueillies.

demandes de signaturesignatures
signature e-Signature

Validations

2

Demandes d'approbation et règles de routage.

demandes-d'approbationrègles-d'approbation
approbations Validations

Fichiers

2

Fichiers téléchargés et documents numérisés.

fichiersdocuments scannés
fichiers Fichiers

Activité

3

Le fil d'activité, le journal d'audit et les notifications.

activitésJournaux d'auditNotifications
Au téléphone

Chaque module lu par l'API est accessible à votre équipe sur son appareil mobile.

C'est la partie qui n'est généralement pas vraie. Beaucoup de plateformes exposent une API étendue, puis livrent une application mobile qui fait trois choses — approuver, visualiser, notifier. L'application Kardopal est le produit, pas un simple compagnon : les 29 modules ci-dessus ont de vrais écrans, et le téléphone est l'endroit où la majeure partie du travail se déroule réellement.

  • Lisez-le, puis agissez. Votre intégration extrait un niveau de stock ; la personne qui doit le corriger ouvre le même enregistrement, l'ajuste et le signe à son nom.
  • Scannez, photographiez, signez. Le scan de codes-barres, la capture de documents et la signature électronique sont natifs du téléphone — ils n'ont pas d'équivalent de bureau utilisable.
  • Tolérant hors ligne au comptoir. La caisse, l'écran de cuisine et l'affichage de la file d'attente continuent de fonctionner lorsque la connexion est instable.
  • Même identifiant, mêmes données, 20 langues. Y compris de droite à gauche, pour qu'une équipe arabophone ne lise pas une mise en page inversée.
Découvrir la plateforme
L'application Kardopal fonctionnant sur un téléphone

Obtenir une clé

Ouvrez l'application, allez à Plateforme → Clés API.Les clés sont créées par un propriétaire ou un administrateur sur votre propre instance. Personne chez Kardopal ne les émet pour vous.
Cochez uniquement les modules nécessaires à l'intégration.Un widget de vitrine a besoin articles. Il n'a pas besoin hr. Les clés restreintes sont sûres.
Envoyez-le en tant qu'en-tête, jamais dans l'URL.X-API-Key: kp_live_… — les chaînes de requête se retrouvent dans les journaux, les proxys et l'historique du navigateur.
Faites pivoter en créant d'abord la nouvelle clé.Les deux fonctionnent simultanément, vous pouvez donc transférer le trafic et révoquer l'ancienne sans aucune interruption de service.

Construire quelque chose dessus

L'API se documente elle-même : créez une clé dans l'application, pointez curl à l'URL de base, et il renvoie chaque module, ressource et champ interrogeable accessible par cette clé.

Créer une clé API