CadiaAPI

API für die Verwendung von Daten in eigenen Portalen, Applikationen, Webseiten

Die CadiaAPI dient dem Abruf von Daten aus der Cadia-Datenbank in strukturierter Form. Die Rückgabe von Daten erfolgt als JSON-Objekt, die Inhalte können dann beliebig in (Fremd)Applikationen, Webseiten oder ähnlichem für Interessenten, Kunden oder Lieferanten genutzt werden (Preisberechnungen, Angebote, Bestellungen).

Einrichtung:

Für den Abruf von Daten muss CadiaServer fertig eingerichtet sein und in den Einstellungen muss die Option CadiaAPI aktiviert sein.

Der erste Teil der URL ist immer identisch und ergibt sich aus den Voreinstellungen und den festen Vorgaben von CadiaServer.

Protokoll://Domain:Port/cadiaserver/cadiaapi
Beispiel: http://langwald-edv.net:2001/cadiaserver/cadiaapi
Danach folgen dann die Parameterangaben für den gewünschten Befehl.

Der erste Parameter wird mit dem ‚?‘ gekennzeichnet, alle weiteren Parameter werden mit dem ‚&‘ verbunden. Jeder Parameter setzt sich aus dem ‚Bezeichner‘ und einem ‚Wert‘ zusammen, zwischen ‚Bezeichner‘ und ‚Wert‘ steht immer ein ‚=‘

Beispiel: ?befehl=login&ipadresse=192.168.10.10&kundennummer=10020&passwort=meinpasswort
Beispiel für die vollständige URL:
http://langwald-edv.net:2001/cadiaserver/cadiaapi?befehl=login&ipadresse=192.168.10.10&kundennummer=10020&passwort=meinpasswort

Folgende Befehle stehen zur Zeit zur Verfügung, darunter jeweils die MUSS-Parameter sowie Kurzbeschreibung:

login
(ipadresse, kundennummer, passwort)
– Die erfolgreiche Ausführung des Abrufes liefert ein JSON-Objekt mit einer SESSIONID, die dann für die Ausführung weiterer Befehle verwendet werden muss. Darüber hinaus werden Kundennummer, Nachname, Email und AdresseBild aus dem Kundendatensatz zurückgegeben

logoff
(sessionid)
– Rückgabe hinweis=ok bei erfolgreicher Abmeldung

passwortaendern
(sessionid, ipadresse, kundennummer, altespasswort, neuespasswort)
– Rückgabe hinweis=ok bei erfolgreicher Ausführung, die Session wird beendet und eine erneute Anmeldung mit den aktuellen Daten ist zwingend erforderlich
– Parameter neuespasswort erfordert mindestens 6 und maximal 20 Zeichen

passwortabfrage
(ipadresse, kundennummer, email)
– Rückgabe: sessionid=LEER, kundennummer, email, passwort und hinweis=ok

auftragsliste
(sessionid, ipadresse, kundennummer)
– Rückgabe: JSONARRAY „auftragsliste“ mit folgenden Feldern: Nummerkomplett, Kundennummer, Datum, Nachname, Auftragsbezeichnung, Nettosumme, Bruttosumme, Lieferdatum, Liefertermin, AdresseBild, LieferanschriftDaten, AuftragStatus, AuftragnummerKunde, BestelldatumKunde, Transportbedingung, ZahlungsbedingungText
– Sowie hinweis=ok

einzelauftrag
(sessionid, ipadresse, kundennummer, auftragsnummer)
– Rückgabe: alle Datenfelder aus dem Auftrag sowie ein JSONARRAY „positionen“ mit allen Datenfeldern aus den Auftragspositionen
Rückgabe bei fehlgeschlagenen Abrufen enthält einen Klartext als Fehlermeldung im JSON-Objekt hinweis={Fehlermeldung}