API & Dokumentation

Ein Schlüssel. Jedes Modul.

Die meisten Unternehmenssoftwares bieten eine API pro Produkt – eine für die Kasse, eine andere für den Lagerbestand, eine dritte für Rechnungen, jede mit eigener Authentifizierung und eigenem Datumsformat. Kardopal hat eine. Derselbe Schlüssel, dieselbe Basis-URL und dieselbe Abfragegrammatik erreichen 129 Ressourcen in 29 Modulen.

API-Schlüssel erstellen Sehen Sie, was es erreicht
29
Module
129
Ressourcen
1
Schlüssel, eine Basis-URL
200
Zeilen pro Seite, max

Warum es sich lohnt, auf dieser API aufzubauen

Sechs Dinge, die hier wahr sind und es sonst meist nicht sind.

Es beschreibt sich selbst

Rufen Sie die Basis-URL auf, und die API liefert ihren eigenen Katalog zurück — jedes Modul, das Ihr Schlüssel sehen kann, jede darin enthaltene Ressource, welche Felder durchsuchbar und welche filterbar sind. Sie benötigen diese Seite nicht, um die Integration zu schreiben; Sie benötigen sie, um sich dafür zu entscheiden.

Berechtigungen, die den Zugang steuern

Scopes, Routen und die Berechtigungs-Pills in der App werden aus einer Liste generiert, sodass eine Berechtigung nur angeboten werden kann, wenn ein Endpunkt dahintersteht. Ein Schlüssel, der auf Artikel ruft Artikel ab – eine Anfrage nach Gehaltsabrechnungen gibt 403 zurück, keine stille leere Seite.

Eine Abfragegrammatik, überall

Suche, seit, bis, Überspringen und Nehmen bedeuten auf Rechnungen dasselbe wie bei Lagerbewegungen. Lernen Sie die Struktur einmal, und jede der 133 Ressourcen folgt ihr.

Ihr Tenant, und nur Ihrer

Jede Tabelle enthält eine Mandanten-ID und jede Abfrage ist auf den Mandanten des Schlüssels beschränkt, bevor sie die Datenbank erreicht. Es gibt keine mandantenübergreifende Leseoperation, die falsch sein könnte, da es keinen Parameter gibt, der eine solche anfordern könnte.

Felder bleiben konsistent

Die Feldliste wird beim Start aus dem Live-Schema gelesen und nicht manuell gepflegt. Eine neue Spalte erscheint von selbst; eine gelöschte kann niemals einen verwaisten Verweis in den Dokumenten oder einen 500er beim ersten Aufruf hinterlassen.

Nur lesbar, absichtlich

Schlüssel lesen; sie schreiben nie. Eine fehlerhafte Integration kann keine Rechnung stornieren oder Lagerbestände verschieben. Jede Änderung eines Datensatzes erfolgt über die App oder einen Mitarbeiter-Login, wo sie einer Person zugeordnet und im Audit-Log erfasst wird.

In einer Anfrage starten

Alles ist ein GET. Wenn Sie verwenden können curl, können Sie dies nutzen.

GET /api/v1Der gesamte Katalog, auf den Ihr Schlüssel zugreifen kann
curl https://api.kardopal.com/api/v1 \
  -H "X-API-Key: kp_live_…"
GET /api/v1/mePlausibilitätsprüfung — wem gehört dieser Schlüssel und was kann er lesen
{
  "authType": "api_key",
  "tenant": { "name": "Nova Retail", "plan": "pro" },
  "scopes": ["items", "sales", "pos"]
}
GET /api/v1/items?search=lamp&take=2Jede Ressource, gleiche Form
{
  "resource": "items",
  "scope": "items",
  "total": 41,
  "skip": 0,
  "take": 2,
  "hasMore": true,
  "data": [ { "id": "…", "name": "Desk Lamp LED" } ]
}
GET /api/v1/meta/countsZeilenanzahl pro Ressource — sehen Sie, welche Daten tatsächlich existieren
curl https://api.kardopal.com/api/v1/meta/counts \
  -H "X-API-Key: kp_live_…"

Die fünf Parameter

ParameterMachtNotizen
SucheGroß- und kleinschreibungsunabhängige Übereinstimmung über die durchsuchbaren Felder der RessourceWelche Felder das sind, ist aufgeführt in /meta
seitNur Aufzeichnungen ab diesem DatumGilt für das Feld, nach dem die Ressource sortiert
bisNur Datensätze bis zu diesem DatumKombinieren mit seit für ein Fenster
ÜberspringenVersatz im ErgebnisdatensatzStandardwert ist 0
NehmenAnzahl der ZeilenStandardmäßig 50, maximal 200

Ressourcen akzeptieren auch exakte Filter für ihre eigenen deklarierten Felder — ?status=bezahlt, ?warehouseId=… — und jeder wirbt dafür, welche das sind. Jede Listenantwort enthält Gesamt und mehr vorhanden, sodass die Paginierung eine Schleife ist, keine Vermutung.

Was die API erreicht

29 Module, 129 Ressourcen. Jede Karte ist eine Berechtigung, die Sie einem Schlüssel erteilen können – und der graue Tag zeigt, wo dieselben Datensätze in der App auf Ihrem Telefon zu finden sind.

Kontakte

2

Kunden, Lieferanten und deren Segmente.

KontakteKontaktsegmente
Kontakte Kontakte

Artikel

7

Der Katalog: Produkte, Varianten, Marken, Preislisten und Einheiten.

ArtikelKategorienMarkenArtikelvariantenPreislistenEinheiten+1 weitere
Artikel Artikel

Bestandsverwaltung

7

Lager, Lagerbestände, Bewegungen, Chargen, Seriennummern und Lagerplätze.

LagerLagerbewegungenLagerbeständeChargenSeriennummernBestandszählungen+1 weitere
Inventar Bestandsverwaltung

Vertrieb

7

Rechnungen, Angebote, Bestellungen, Gutschriften und Zahlungen.

RechnungenKostenvoranschlägeVerkaufsaufträgeGutschriftenZahlungenwiederkehrende Rechnungen+1 weitere
Vertrieb Vertrieb

POS

11

Kassen, Schichten, Belege, Tische und jeder Verkauf, der über die Theke ging.

POS-VerkäufePOS-SchichtenPOS-TerminalsPOS-BenutzerPOS-Tischepos-tischbereiche+5 weitere
pos POS

CRM

4

Leads, Deals, Pipelines und Angebote.

LeadsAngebotePipelinesAngebote
crm CRM

Einkauf

5

Bestellungen, Anfragen, Retouren, Rechnungen und Lieferantenzahlungen.

BestellungenBestellanfragenEinkaufsretourenRechnungenLieferantenzahlungen
Einkauf Einkauf

Buchhaltung

5

Ausgaben, Bankkonten, Transaktionen und Steuersätze.

AusgabenAusgabenkategorienbankkontenbank-transactionsSteuersätze
Buchhaltung Buchhaltung

Marketing

4

Kampagnen, Empfänger, Landingpages und Formularübermittlungen.

KampagnenKampagnenempfängerLandingpagesFormularübermittlungen
Marketing Marketing

HR

8

Mitarbeiter, Abteilungen, Urlaub, Gehaltsabrechnungen, Anwesenheit und Einstellung.

MitarbeiterAbteilungenleave-requestsGehaltsabrechnungenAnwesenheitStellenangebote+2 weitere
hr HR

Arbeitszeittabelle

2

Zeiteinträge und die Projekte, denen sie zugeordnet sind.

ZeiteinträgeZeiterfassung-Projekte
Zeiterfassung Arbeitszeittabelle

Projekte

3

Projekte, Phasen und die damit verbundenen Kosten.

ProjekteProjektphasenProjektkosten
Projekte Projekte

Buchung

3

Termine, buchbare Dienstleistungen und das Personal, das sie erbringt.

BuchungenBuchungsdienstepersonalbuchung
Buchung Buchung

Außendienst

7

Aufträge, Techniker, Arbeitsaufträge, Verträge und Ausrüstung.

FeldaufträgeTechnikerServiceanfragenServiceverträgeArbeitsaufträgeArbeitskarten+1 weitere
Außendienst Außendienst

Logistik

5

Sendungen, Fahrer, Fahrzeuge, Zonen und Spediteure.

LieferungenFahrerFahrzeugeLieferzonenSpediteure
Logistik Logistik

Helpdesk

5

Tickets, SLA-Richtlinien, Hilfeartikel und die Wissensdatenbank.

TicketsKunden-TicketsHilfeartikelWissensdatenbankSLA-Richtlinien
Support Helpdesk

Post-Sales

5

Retouren, Garantieansprüche, Reparaturen und Produktregistrierungen.

RMAsGarantieansprücheGarantieregistrierungenReparaturenProduktregistrierungen
Nachverkäufe Post-Sales

Vermietung

3

Vermietbare Vermögenswerte, Mietverträge und deren Positionen.

AnlagenVermietungenMietpositionen
Miete Vermietung

Restaurant

2

Die Speisekarte und die darauf basierenden Bestellungen.

MenüpunkteMenübestellungen
Restaurant F&B

Warteschlange

5

Tickets, Dienstleistungen, Schalter, Filialen und die Anzeigebildschirme.

WartemarkenWarteschlangen-DiensteWarteschlangenzählerWarteschlangen-FilialenWarteschlangenanzeigen
Warteschlange Warteschlange

Treue

6

Mitglieder, Konten, Stufen, Belohnungen und Punkttransaktionen.

loyalty-membersKundenkontenTreueprämienTreue-StufenTreuetransaktionenloyalty-coupons
Kundenbindung Treue

Standorte

2

Standorte und Filialen.

StandorteFilialen
Standorte Standorte

IOT

6

Geräte, Standorte, Boxen, Warnmeldungen, Ereignisse und Inhalte für die Beschilderung.

iot-Geräteiot-sitesIoT-Benachrichtigungeniot-EreignisseIoT-BoxenIoT-Beschilderungsinhalte
iot IOT Hub

AI Studio

3

Generierte Assets, die zugehörigen Projekte und die Job-Historie.

KI-AssetsKI-Projekteai-jobs
ai_studio AI Studio

Handel

3

Netzwerkmitglieder, Angebotsanfragen und Inkasso.

NetzwerkmitgliederAngebotsanfragenKollektionen
Handel Handel

e-Signatur

2

Signaturanfragen und die dazu gesammelten Unterschriften.

UnterschriftsanfragenSignaturen
Unterschrift e-Sign

Genehmigungen

2

Genehmigungsanfragen und die Regeln, die sie weiterleiten.

GenehmigungsanfragenGenehmigungsregeln
Genehmigungen Genehmigungen

Dateien

2

Hochgeladene Dateien und gescannte Dokumente.

Dateiengescannte Dokumente
Dateien Dateien

Aktivität

3

Der Aktivitäts-Feed, das Audit-Log und Benachrichtigungen.

AktivitätenAudit-ProtokolleBenachrichtigungen
Am Telefon

Jedes Modul, das die API liest, kann Ihr Team mobil aufrufen.

Das ist der Teil, der normalerweise nicht stimmt. Viele Plattformen bieten eine breite API und liefern dann eine mobile App, die drei Dinge tut — genehmigen, anzeigen, benachrichtigen. Die App von Kardopal ist das Produkt, nicht ein Begleiter: Alle 29 oben genannten Module haben echte Bildschirme, und das Telefon ist der Ort, an dem die meiste Arbeit tatsächlich stattfindet.

  • Lesen Sie es, dann handeln Sie danach. Ihre Integration ruft einen Lagerbestand ab; die Person, die es beheben muss, öffnet denselben Datensatz, passt ihn an und er wird auf ihren Namen signiert.
  • Scannen, fotografieren, unterschreiben. Barcode-Scanning, Dokumentenerfassung und E-Signatur sind telefon-nativ – sie haben kein Desktop-Äquivalent, das sich lohnen würde.
  • Offline-tolerant an der Kasse. Die Kasse, der Küchenbildschirm und die Warteschlangenanzeige funktionieren weiter, wenn die Verbindung stockt.
  • Gleicher Login, gleiche Daten, 20 Sprachen. Inklusive Rechts-nach-links-Schrift, damit ein arabischsprachiges Team kein gespiegeltes Layout liest.
Die Plattform ansehen
Die Kardopal App auf einem Telefon

Einen Schlüssel erhalten

Öffnen Sie die App, gehen Sie zu Plattform → API-Schlüssel.Schlüssel werden von einem Eigentümer oder Administrator in Ihrem eigenen Tenant erstellt. Niemand bei Kardopal stellt sie für Sie aus.
Wählen Sie nur die Module aus, die die Integration benötigt.Ein Schaufenster-Widget benötigt Artikel. Es benötigt keine hr. Eng gefasste Schlüssel sind ausfallsicher.
Als Header senden, niemals in der URL.X-API-Key: kp_live_… — Abfragezeichenfolgen landen in Protokollen, Proxys und im Browserverlauf.
Rotieren Sie, indem Sie zuerst den neuen Schlüssel erstellen.Beide funktionieren gleichzeitig, sodass Sie den Traffic verschieben und den alten widerrufen können, ohne Ausfallzeiten zu haben.

Bauen Sie etwas darauf auf

Die API dokumentiert sich selbst: Erstellen Sie einen Schlüssel in der App, zeigen Sie curl an der Basis-URL, und es gibt jedes Modul, jede Ressource und jedes durchsuchbare Feld zurück, auf das dieser Schlüssel zugreifen kann.

API-Schlüssel erstellen