kbDATA API
Diese Dokumentation begleitet Sie durch Grundlagen, Anwendungsfälle und die technische Referenz der kbDATA Webservices API.
Die kbDATA Webservices API deckt vier Kernaufgaben ab: Adressen suchen und abgleichen (Search/Match), Datensätze nachladen (Data), lizenzierte Bestände beziehen (Delivery) und grosse Mengen im Batch verarbeiten (AddressProcessing). Alle Endpunkte sind unter https://webservices.kbdata.ch/api erreichbar.
Die Bereiche stehen unabhängig nebeneinander – Sie nutzen jeweils nur, was Sie für Ihren Anwendungsfall brauchen, nicht einen festen Ablauf:
- Authentifizieren – für jeden Aufruf nötig, Zugangstoken beziehen, siehe Authentifizierung.
- Datenquelle wählen – jeder Aufruf braucht einen
source-Wert (kbc/kbb/kbg/...), siehe Datenquellen. Welche Ihnen überhaupt zur Verfügung stehen, regelt das Berechtigungskonzept. - Datensatz finden – Search oder Match, liefert die
dwhId. - Details nachladen – Data mit der
dwhId, um Zusatzkriterien oder Beziehungen abzurufen. - Lizenzierte Bestände beziehen – Delivery für den Download ganzer Datenbestände.
Nur wenn Sie viele Datensätze auf einmal verarbeiten statt einzelner Aufrufe, lohnt sich der Batch-Workflow über AddressProcessing.
Die DWH-ID zieht sich durch alle Bereiche und lohnt sich, bevor Sie loslegen.
Werkzeuge
- Swagger – interaktive Endpunktübersicht, Endpunkte direkt testen: webservices.kbdata.ch/swagger
- Scalar – alternative API-Referenzoberfläche: webservices.kbdata.ch/scalar/v1
- Postman – die Swagger-Spec lässt sich direkt in Postman importieren, um Requests ohne eigenen Code zu testen.
- Support & Kontakt – Fragen zur Integration oder zum Zugang: Support-Team.
Wie sich die API konkret für reale Szenarien einsetzen lässt, zeigen die Anwendungsfälle – die Business-Perspektive dazu auf kbdirect.ch/kbDATA-Webservice-API.