API e documentazione

Una chiave. Ogni modulo.

La maggior parte dei software aziendali offre un'API per prodotto — una per la cassa, un'altra per il magazzino, una terza per le fatture, ognuna con la propria autenticazione e la propria logica per le date. Kardopal ne ha una. La stessa chiave, lo stesso URL di base e la stessa grammatica di query raggiungono 129 risorse attraverso 29 moduli.

Crea una chiave API Vedi cosa raggiunge
29
Moduli
129
Risorse
1
Chiave, un URL base
200
Righe per pagina, max

Perché vale la pena costruire su questa API

Sei cose che qui sono vere e di solito non lo sono.

Si descrive da sé

Richiedi l'URL di base e l'API restituisce il proprio catalogo — ogni modulo che la tua chiave può vedere, ogni risorsa al suo interno, quali campi sono ricercabili e quali filtrabili. Non ti serve questa pagina per scrivere l'integrazione; ti serve per decidere di farlo.

Permessi che controllano l'accesso

Gli ambiti, le rotte e le etichette di permesso nell'app sono generati da un'unica lista, quindi un permesso non può essere offerto a meno che non ci sia un endpoint dietro di esso. Una chiave con ambito a articoli. ottiene gli articoli — chiederle il payroll restituisce 403, non una pagina vuota e silenziosa.

Una grammatica di query, ovunque

cerca, dal, fino a, salta e ottieni significano la stessa cosa sulle fatture e sui movimenti di magazzino. Impara la struttura una volta e ognuna delle 133 risorse risponderà ad essa.

Il tuo tenant, e solo il tuo

Ogni tabella contiene un ID tenant e ogni query è limitata al tenant della chiave prima di raggiungere il database. Non ci sono letture cross-tenant che possano generare errori, perché non esiste alcun parametro che possa richiederne una.

I campi si mantengono validi

L'elenco dei campi viene letto dallo schema live all'avvio anziché essere mantenuto manualmente. Una nuova colonna appare da sola; una eliminata non può mai lasciare un riferimento pendente nella documentazione o un errore 500 alla prima chiamata.

Sola lettura, di proposito.

Le chiavi leggono; non scrivono mai. Un'integrazione che va storta non può annullare una fattura o spostare le scorte. Qualsiasi cosa che modifichi un record passa attraverso l'app o un login del personale, dove viene attribuita a una persona e finisce nel registro di controllo.

Inizia con una richiesta

Tutto è un GET. Se puoi usare curl, potete usarlo.

GET /api/v1L'intero catalogo visibile dalla vostra chiave
curl https://api.kardopal.com/api/v1 \
  -H "X-API-Key: kp_live_…"
GET /api/v1/meControllo di integrità — di chi è questa chiave e cosa può leggere
{
  "authType": "api_key",
  "tenant": { "name": "Nova Retail", "plan": "pro" },
  "scopes": ["items", "sales", "pos"]
}
GET /api/v1/items?search=lamp&take=2Qualsiasi risorsa, stessa forma
{
  "resource": "items",
  "scope": "items",
  "total": 41,
  "skip": 0,
  "take": 2,
  "hasMore": true,
  "data": [ { "id": "…", "name": "Desk Lamp LED" } ]
}
GET /api/v1/meta/countsConteggio righe per risorsa — vedi quali dati esistono realmente
curl https://api.kardopal.com/api/v1/meta/counts \
  -H "X-API-Key: kp_live_…"

I cinque parametri

ParametroFaNote
cercaCorrispondenza senza distinzione tra maiuscole e minuscole nei campi ricercabili della risorsaI campi sono elencati in /meta
dalSolo registrazioni da questa data in poiSi applica al campo in base al quale la risorsa ordina
fino aSolo registrazioni fino a questa dataCombina con dal per una finestra
saltaOffset nel set di risultati.Predefinito a 0
ottieniQuante righe restituirePredefinito a 50, massimo 200

Le risorse accettano anche filtri a corrispondenza esatta sui propri campi dichiarati — ?status=pagato, ?warehouseId=… — e ognuno pubblicizza quali sono. Ogni risposta di elenco contiene totale e ha più, così la paginazione è un ciclo, non un'ipotesi.

Cosa raggiunge l'API.

29 moduli, 129 risorse. Ogni scheda è un permesso che puoi concedere a una chiave — e il tag grigio indica dove si trovano gli stessi record nell'app sul tuo telefono.

Contatti

2

Clienti, fornitori e i segmenti a cui appartengono.

contattisegmenti di contatto
contatti Contatti

Articoli

7

Il catalogo: prodotti, varianti, marchi, listini prezzi e unità.

articoli.categoriemarchivarianti-articololistini-prezziunità+1 altro
articoli. Articoli

Inventario

7

Magazzini, livelli di scorte, movimenti, lotti, numeri di serie e ubicazioni.

magazzinimovimenti-di-magazzinostock-levelslottiserialiconteggi-scorte+1 altro
inventario Inventario

Vendite

7

Fatture, preventivi, ordini, note di credito e pagamenti.

fatturepreventiviordini di venditanote di creditopagamentifatture-ricorrenti+1 altro
vendite Vendite

POS

11

Casse, turni, ricevute, tavoli e ogni vendita che ha attraversato il banco.

pos-salesturni-posterminali-posutenti POStavoli POSaree-tavoli-pos+5 altro
pos POS

CRM

4

Lead, trattative, pipeline e proposte.

leadoffertepipelineproposte
crm CRM

Acquisti

5

Ordini di acquisto, richieste, resi, fatture e pagamenti ai fornitori.

ordini-di-acquistorichieste-di-acquistoresi-acquisticontipagamenti-fornitori
acquisto Acquisti

Contabilità

5

Spese, conti bancari, transazioni e aliquote fiscali.

spesecategorie-di-spesaconti-bancaritransazioni-bancariealiquote-fiscali
contabilità Contabilità

Marketing

4

Campagne, destinatari, landing page e invii di moduli.

campagnedestinatari-campagnalanding-pageinvii di moduli
marketing Marketing

HR

8

Persone, dipartimenti, ferie, buste paga, presenze e assunzioni.

dipendentirepartirichieste-di-permessobuste pagapresenzeannunci-di-lavoro+2 altro
hr HR

Foglio presenze

2

Registrazioni orarie e i progetti a cui sono assegnate.

registrazioni-orarieprogetti-timesheet
scheda presenze Foglio presenze

Progetti

3

Progetti, fasi e i costi a essi associati.

progettifasi-del-progettocosti-progetto
progetti Progetti

Prenotazioni

3

Appuntamenti, servizi prenotabili e il personale che li eroga.

prenotazioniservizi di prenotazionepersonale-prenotazioni
prenotazione Prenotazioni

Servizi sul campo

7

Lavori, tecnici, ordini di lavoro, contratti e attrezzature.

lavori-sul-campotecnicirichieste-di-serviziocontratti-di-servizioordini-di-lavoroschede-lavoro+1 altro
field_service Servizi sul campo

Logistica.

5

Spedizioni, autisti, veicoli, zone e corrieri.

spedizioniautistiveicolizone-di-consegnacorrieri
logistica Logistica.

Helpdesk

5

Ticket, politiche SLA, articoli di aiuto e la base di conoscenza.

ticketcustomer-ticketsarticoli-di-aiutobase di conoscenzapolitiche-sla
supporto Helpdesk

Post-vendita

5

Resi, richieste di garanzia, riparazioni e registrazioni di prodotti.

rmasrichieste-di-garanziaregistrazioni-garanziariparazioniregistrazioni-prodotto
post_vendita Post-vendita

Noleggio

3

Beni noleggiabili, contratti di noleggio e le loro voci.

beninoleggilinee-di-noleggio
noleggio Noleggio

Ristorante

2

Il menu e gli ordini effettuati.

voci-di-menuordini-menu
ristorante F&B

Coda

5

Comande, servizi, sportelli, filiali e schermi display.

biglietti-codaservizi-codacontatori-codacode-filialidisplay-coda
coda Coda

Fidelizzazione

6

Membri, account, livelli, premi e transazioni a punti.

membri-fedeltàconti-fedeltàpremi-fedeltàlivelli fedeltàtransazioni-fedeltàcoupon-fedeltà
fedeltà Fidelizzazione

Sedi

2

Siti e filiali.

sedifiliali
sedi Sedi

IOT

6

Dispositivi, siti, box, avvisi, eventi e contenuti per la segnaletica.

dispositivi-iotsiti-iotallarmi IoTeventi-iotiot-boxescontenuto-segnaletica-iot
iot Hub IOT

AI Studio

3

Risorse generate, i progetti che le contengono e la cronologia dei lavori.

risorse-aiprogetti-aiai-jobs
ai_studio AI Studio

Commerce

3

Membri della rete, richieste di preventivo e incassi.

membri della reterichieste-di-preventivocollezioni
commercio Commerce

Firma elettronica

2

Richieste di firma e le firme raccolte.

richieste di firmafirme
firma e-Sign

Approvazioni

2

Richieste di approvazione e le regole che le instradano.

richieste-di-approvazioneregole-di-approvazione
approvazioni Approvazioni

File

2

File caricati e documenti scansionati.

filedocumenti-scansionati
file File

Attività

3

Il feed delle attività, il log di audit e le notifiche.

attivitàlog di auditnotifiche
Al telefono

Ogni modulo letto dall'API, il tuo team può aprirlo sul proprio dispositivo.

Questa è la parte che di solito non è vera. Molte piattaforme espongono un'API ampia e poi rilasciano un'app mobile che fa tre cose — approvare, visualizzare, notificare. L'app di Kardopal è il prodotto, non un complemento: tutti i 29 moduli sopra hanno schermate reali, e il telefono è dove la maggior parte del lavoro avviene.

  • Leggi, poi agisci. La tua integrazione estrae un livello di stock; la persona che deve risolvere il problema apre lo stesso record, lo modifica e lo firma a proprio nome.
  • Scansiona, fotografa, firma. La scansione di codici a barre, l'acquisizione di documenti e la firma elettronica sono native per il telefono — non hanno un equivalente desktop degno di essere usato.
  • Tollerante all'offline al banco. La cassa, lo schermo della cucina e il display della coda continuano a funzionare anche con una connessione instabile.
  • Stesso login, stessi dati, 20 lingue. Incluso il supporto da destra a sinistra, così un team di lingua araba non legge un layout specchiato.
Scopri la piattaforma.
L'app Kardopal in esecuzione su un telefono

Ottenere una chiave

Apri l'app, vai su Piattaforma → Chiavi API.Le chiavi sono create da un proprietario o amministratore sul tuo tenant. Nessuno in Kardopal le emette per te.
Seleziona solo i moduli necessari all'integrazione.Un widget per vetrina ha bisogno di articoli.. Non ha bisogno di hr. Le chiavi strette sono a prova di errore.
Invialo come header, mai nell'URL.X-API-Key: kp_live_… — le stringhe di query finiscono nei log, nei proxy e nella cronologia del browser.
Ruotate creando prima la nuova chiave.Entrambi funzionano contemporaneamente, così puoi spostare il traffico e revocare il vecchio senza interruzioni del servizio.

Costruiscici qualcosa sopra

L'API si documenta da sola: crea una chiave nell'app, punta curl all'URL di base, e restituisce ogni modulo, risorsa e campo ricercabile che quella chiave può raggiungere.

Crea una chiave API