API & documentatie

Eén sleutel. Elke module.

De meeste bedrijfssoftware geeft u een API per product — één voor de kassa, één voor de voorraad, een derde voor facturen, elk met zijn eigen authenticatie en zijn eigen idee van een datum. Kardopal heeft er één. Dezelfde sleutel, dezelfde basis-URL en dezelfde querygrammatica bereiken 129 bronnen verdeeld over 29 modules.

API-sleutel aanmaken Bekijk wat het bereikt
29
Modules
129
Middelen
1
Sleutel, één basis-URL
200
Rijen per pagina, max

Waarom deze API de moeite waard is om op te bouwen

Zes dingen die hier waar zijn en dat meestal niet zijn.

Het beschrijft zichzelf

Roep de basis-URL aan en de API geeft zijn eigen catalogus terug — elke module die uw sleutel kan zien, elke bron daarin, welke velden doorzoekbaar zijn en welke filterbaar. U hebt deze pagina niet nodig om de integratie te schrijven; u hebt hem nodig om te beslissen.

Machtigingen die echt afschermen

Scopes, routes en de permissies in de app worden gegenereerd vanuit één lijst, zodat een permissie niet kan worden aangeboden tenzij er een endpoint achter zit. Een sleutel gescopeerd op artikelen krijgt items — een verzoek om salarisadministratie retourneert 403, geen stille lege pagina.

Eén querygrammatica, overal

zoeken, sinds, tot, overslaan en nemen betekenen hetzelfde op facturen als op voorraadbewegingen. Leer de structuur één keer en elk van de 133 bronnen volgt deze.

Uw tenant, en alleen de uwe

Elke tabel heeft een tenant-ID en elke query is beperkt tot de eigen tenant van de sleutel voordat deze de database bereikt. Er is geen cross-tenant leesactie die fout kan gaan, omdat er geen parameter is die erom zou kunnen vragen.

Velden controleren zichzelf

De veldenlijst wordt bij het opstarten uit het live schema gelezen in plaats van handmatig te worden bijgehouden. Een nieuwe kolom verschijnt vanzelf; een verwijderde kolom kan nooit een zwevende verwijzing in de documentatie of een 500 bij de eerste aanroep achterlaten.

Alleen-lezen, met opzet

Sleutels lezen; ze schrijven nooit. Een integratie die fout gaat, kan een factuur niet ongeldig maken of voorraad verplaatsen. Alles wat een record wijzigt, gaat via de app of een personeelslogin, waar het wordt toegeschreven aan een persoon en in het auditlogboek terechtkomt.

Start in één aanvraag

Alles is een GET. Als u kunt gebruiken curl, kunt u dit gebruiken.

GET /api/v1De hele catalogus die uw sleutel kan zien
curl https://api.kardopal.com/api/v1 \
  -H "X-API-Key: kp_live_…"
GET /api/v1/meSanity check — van wie is deze sleutel, en wat kan deze lezen
{
  "authType": "api_key",
  "tenant": { "name": "Nova Retail", "plan": "pro" },
  "scopes": ["items", "sales", "pos"]
}
GET /api/v1/items?search=lamp&take=2Elke bron, dezelfde vorm
{
  "resource": "items",
  "scope": "items",
  "total": 41,
  "skip": 0,
  "take": 2,
  "hasMore": true,
  "data": [ { "id": "…", "name": "Desk Lamp LED" } ]
}
GET /api/v1/meta/countsAantal rijen per bron — zie welke gegevens daadwerkelijk bestaan
curl https://api.kardopal.com/api/v1/meta/counts \
  -H "X-API-Key: kp_live_…"

De vijf parameters

ParameterDoetNotities
zoekenNiet-hoofdlettergevoelige overeenkomst in de doorzoekbare velden van de resourceWelke velden dat zijn, staat vermeld in /meta
sindsAlleen gegevens vanaf deze datumVan toepassing op het veld waarop de resource sorteert
totAlleen records tot deze datumCombineer met sinds voor een venster
overslaanOffset in de resultatensetStandaard 0
nemenAantal rijen om terug te gevenStandaard 50, maximaal 200

Bronnen accepteren ook exacte-match filters op hun eigen gedeclareerde velden — ?status=betaald, ?warehouseId=… — en elk daarvan adverteert welke dat zijn. Elke lijstrespons bevat totaal en heeftMeer, dus paginering is een lus, geen gok.

Wat de API bereikt

29 modules, 129 bronnen. Elke kaart is één permissie die u een sleutel kunt verlenen — en de grijze tag toont waar dezelfde records zich bevinden in de app op uw telefoon.

Contacten

2

Klanten, leveranciers en de segmenten waarin ze zich bevinden.

contactencontactsegmenten
contacten Contacten

Artikelen

7

De catalogus: producten, varianten, merken, prijslijsten en eenheden.

artikelencategorieënmerkenartikelvariantenprijslijsteneenheden+1 meer
artikelen Artikelen

Voorraadbeheer

7

Magazijnen, voorraadniveaus, bewegingen, batches, serienummers en opslaglocaties.

magazijnenvoorraadbewegingenvoorraadniveausbatchesserienummersvoorraadtellingen+1 meer
voorraad Voorraadbeheer

Verkoop

7

Facturen, offertes, orders, creditnota's en betalingen.

facturenschattingenverkooporderscreditnota'sbetalingenterugkerende facturen+1 meer
verkoop Verkoop

POS

11

Kassa's, diensten, bonnen, tafels en elke verkoop die over de toonbank ging.

pos-verkopenpos-dienstenpos-terminalspos-gebruikerspos-tafelspos-tafelgebieden+5 meer
pos POS

CRM

4

Leads, deals, pijplijnen en voorstellen.

leadsdealspijplijnenvoorstellen
crm CRM

Inkoop

5

Inkooporders, aanvragen, retouren, facturen en leveranciersbetalingen.

inkoopordersinkoopaanvrageninkoopretourenrekeningenleveranciersbetalingen
aankoop Inkoop

Boekhouding

5

Kosten, bankrekeningen, transacties en belastingtarieven.

kostenonkostencategorieënbankrekeningenbanktransactiesbelastingtarieven
boekhouding Boekhouding

Marketing

4

Campagnes, ontvangers, landingspagina's en formulierinzendingen.

campagnescampaign-recipientslandingspagina'sformulierinzendingen
marketing Marketing

HR

8

Personeel, afdelingen, verlof, loonstroken, aanwezigheid en werving.

medewerkersafdelingenverlofaanvragenloonstrokenaanwezigheidvacatures+2 meer
hr HR

Urenstaat

2

Tijdregistraties en de projecten waartegen ze worden geboekt.

tijdregistratiestijdregistratieprojecten
urenstaat Urenstaat

Projecten

3

Projecten, fasen en de bijbehorende kosten.

projectenprojectfasenprojectkosten
projecten Projecten

Boekingen

3

Afspraken, boekbare diensten en het personeel dat ze levert.

boekingenboekingsdienstenpersoneelsplanning
boeking Boekingen

Buitendienst

7

Taken, technici, werkorders, contracten en apparatuur.

buitendiensttakentechniciserviceverzoekenservicecontractenwerkorderswerkkaarten+1 meer
buitendienst Buitendienst

Logistiek.

5

Zendingen, chauffeurs, voertuigen, zones en vervoerders.

zendingenchauffeursvoertuigenbezorggebiedenvervoerders
logistiek Logistiek.

Helpdesk

5

Tickets, SLA-beleid, helpartikelen en de kennisbank.

ticketsklantticketshelp-artikelenkennisbanksla-beleid
ondersteuning Helpdesk

Naverkoop

5

Retouren, garantieclaims, reparaties en productregistraties.

rma'sgarantieclaimsgarantieregistratiesreparatiesproductregistraties
naverkoop Naverkoop

Verhuur

3

Verhuurbare activa, huurovereenkomsten en hun regels.

activaverhuurhuurregels
verhuur Verhuur

Restaurant

2

Het menu en de bestellingen die erop geplaatst zijn.

menu-itemsmenu-bestellingen
restaurant Horeca

Wachtrij

5

Tickets, diensten, balies, vestigingen en de displayschermen.

wachtrijticketswachtrijservicesrijtellerswachtrij-vestigingenwachtrijdisplays
wachtrij Wachtrij

Loyaliteit

6

Leden, accounts, niveaus, beloningen en puntentransacties.

loyaliteitsledenloyaliteitsaccountsloyaliteitsbeloningenloyaliteitsniveausloyaliteitstransactiesloyaliteitscoupons
loyaliteit Loyaliteit

Locaties

2

Locaties en vestigingen.

locatiesvestigingen
locaties Locaties

IOT

6

Apparaten, locaties, boxen, meldingen, evenementen en signage-content.

iot-apparateniot-locatiesiot-meldingeniot-gebeurtenisseniot-boxeniot-signage-content
iot IOT Hub

AI Studio

3

Gegenereerde activa, de projecten die ze bevatten en de taakgeschiedenis.

AI-activaai-projectenai-jobs
ai_studio AI Studio

Commerce

3

Netwerkleden, offerteaanvragen en incasso's.

netwerkledenofferteaanvragencollecties
handel Commerce

E-handtekening

2

Handtekeningverzoeken en de verzamelde handtekeningen.

handtekeningverzoekenhandtekeningen
handtekening e-Handtekening

Goedkeuringen

2

Goedkeuringsaanvragen en de regels die ze routeren.

approval-requestsgoedkeuringsregels
goedkeuringen Goedkeuringen

Bestanden

2

Geüploade bestanden en gescande documenten.

bestandengescande-documenten
bestanden Bestanden

Activiteit

3

De activiteitenfeed, auditlog en meldingen.

activiteitenauditlogboekenmeldingen
Telefonisch

Elke module die de API leest, kan uw team in handen hebben.

Dit is het deel dat meestal niet waar is. Veel platforms bieden een brede API en leveren vervolgens een mobiele app die drie dingen doet — goedkeuren, bekijken, melden. De app van Kardopal is het product, geen aanvulling: alle 29 modules hierboven hebben echte schermen, en de telefoon is waar het meeste werk daadwerkelijk gebeurt.

  • Lees het, en handel ernaar. Uw integratie haalt een voorraadniveau op; de persoon die het moet oplossen, opent dezelfde record, past deze aan en het wordt op diens naam geregistreerd.
  • Scannen, fotograferen, ondertekenen. Barcodescanning, documentvastlegging en e-handtekening zijn telefoon-native — ze hebben geen bruikbaar desktop-equivalent.
  • Offlinetolerant aan de balie. De kassa, het keukenscherm en het wachtrijscherm blijven werken wanneer de verbinding hapert.
  • Zelfde login, zelfde gegevens, 20 talen. Inclusief van rechts naar links, zodat een Arabisch sprekend team geen gespiegelde lay-out leest.
Bekijk het platform.
De Kardopal app draaiend op een telefoon

Een sleutel verkrijgen

Open de app, ga naar Platform → API-sleutels.Sleutels worden aangemaakt door een eigenaar of beheerder op uw eigen tenant. Niemand bij Kardopal geeft ze voor u uit.
Vink alleen de modules aan die de integratie nodig heeft.Een etalage-widget heeft artikelen. Het heeft geen hr. Smalle sleutels werken fail-safe.
Verstuur het als een header, nooit in de URL.X-API-Key: kp_live_… — query strings komen terecht in logs, proxies en browsergeschiedenis.
Roteer door eerst de nieuwe sleutel aan te maken.Beide werken tegelijk, zodat u verkeer kunt verplaatsen en de oude kunt intrekken zonder downtime.

Bouw er iets op

De API documenteert zichzelf: maak een sleutel aan in de app, wijs curl op de basis-URL, en het geeft elke module, bron en doorzoekbaar veld terug waartoe die sleutel toegang heeft.

API-sleutel aanmaken