MERCATOR API
Mit Hilfe der MERCATOR API können Daten aus der MERCATOR Datenbank über externe oder eigene Zusatzanwendungen abgerufen werden. Dabei ist hier der Datenabruf auf Seite des Clients an sich völlig unabhängig von der eingesetzten Programmiersprache oder des eingesetzten Betriebssystems.
Die API („Application Programming Interface“) stellt eine Art standardisierte Schnittstelle zu Ihrer MERCATOR Datenbank dar. Der Zugriff kann hier rein im eigenen Firmennetzwerk (Intranet) erfolgen als auch extern über das Internet (für einen externen Zugriff muss Ihr eingesetzter Server nach außen abgesichert erreichbar sein).
Datenbereiche
Die MERCATOR API ist streng nach dem REST Paradigma konzipiert und strukturiert, wodurch ein Zugriff in einem bestimmten Standard erfolgen kann. Über fest definierte Datenbereiche wie z.B. Kunden, Kundengruppen, Aufträge, Statistik … können Daten in Listen oder Detailanfragen abgerufen werden. Die Daten werden lesend als auch schreibend im JSON Format („JavaScript Object Notation“) verarbeitet, und weisen im Vergleich zu XML einen geringeren Overhead vor. Selektionsmöglichkeiten werden je nach Datenbereich individuell gegeben, damit Sie die Daten nach Ihren Wünschen abrufen können.
Hinweis: Weitere Datenbereiche sind bereits in Entwicklung und werden fortlaufend für alle MERCATOR API Nutzer veröffentlicht.
Technik
Die Web API ist auf Basis von .NET programmiert und greift für eine hohe Performance und Stabilität nativ auf die SQLBase Datenbank über den SQLBase .NET Data Provider zu. Die Autorisierung erfolgt per HTTP Basic Authentication und den in MERCATOR verwendeten Benutzerdaten. Dabei wird bei jeder Anfrage entschieden, auf welchen Mandanten zugegriffen werden soll.
Hinweis: Sie können in der API Konfiguration über die Web.config auch Mandanten definieren, die generell im Zugriff per API ausgeschlossen werden. Diese Ausschluss-Mandanten sind unter keinen Umständen von außen erreichbar!
Aufbau
Die MERCATOR API ist wie eingangs erwähnt eine vollwertige REST API und dementsprechend auch so strukturiert. Jede Anfrage bestimmt per URL Aufbau, welcher Mandant und welcher Datenbereich verwendet werden soll:
https://[IP/URL]/api/[MANDANT]/[ENDPUNKT]/[ACTION|ID]
| Bereich | Beschreibung |
|---|---|
| IP/URL | Die Adresse Ihres Servers (IIS). Der Zugriff kann lokal im Netzwerk als auch extern (Remote) erfolgen (per DynDNS/DDNS) |
| Mandant | Name des Mandanten, den Sie in der Anfrage nutzen möchten, z.B. mand001 |
| Endpunkt | Name des API Bereiches (weitere Details in der Online-Hilfe) |
| Action|ID | ID des anzusteuernden Datensatzes oder ein expliziter Unterbereich je nach Endpunkt |
Selektions- und Filtermöglichkeiten werden per GET Parameter realisiert.
Anwendungsbeispiele
Greyhound
Greyhound CRM ist ein ideales Werkzeug um Kundenanfragen zu managen. Eine einfache Kommunikation zwischen Ihnen, Ihren Kollegene und Kunden wird mit Greyhound ermöglicht. Nahezu alle Kanäle wie Formulare, E-Mail, Fax, Telefon bzw. Telefonie, Chats, … werden erschlossen und in ein System geholt.
Mit Hilfe des Greyhound MERCATOR Connect Addons im Zusammenspiel mit der MERCATOR API können beide Seiten mit einander verbunden werden: Neben der E-Mail in Greyhound werden alle wichtigen Informationen des Kunden direkt aus MERCATOR Live bezogen und angezeigt. Der Kundenservice kann so direkt auf Daten wie Zahlungs- und Versandarten, Auftragspositionen, Kanal der Bestellung, Sendungsdaten, Beträge, Adressen oder vielen weiteren zugreifen: Einfach E-Mail markieren und in der Seitenleiste alle Daten live einsehen. Ein Klick auf Paketnummern zeigt die Sendungsverfolgung an (Paketnummernkreise können bestimmten Versanddienstleistern zugewiesen werden).
iOS/Android App
Es befinden sich Apps für zum einen einfache Dateneinsichten als auch für Lager-Funktionen in Entwicklung. Android als auch iOS Apps können hier über die gleiche Anbindung mit MERCATOR kommunizieren, um Daten (Aufräge, Kundendaten, Statistiken) einzusehen. Lager-Funktionen (Kommissionierung, Lagerumbuchungen, …) werden in einem gesonderten Teil behandelt und können (auch extern) über die MERCATOR API direkt mit MERCATOR Daten arbeiten.
