Seite als PDF downloaden

Unsere GPS Fleet Software API erlaubt es Software von dritten Daten von unserem System abzurufen und Daten einzuspielen um kooperative Programme und Apps zu realisieren. Mit unserer API ermöglichen wir es anderen Entwicklern eine Synergie zwischen unserer GPS Fleet Software und deren Server oder App herzustellen. Für Anwendungsfälle in der folgenden Dokumentation werde ich unser Hosting benutzen, die API ist jedoch auch mit einem eigenen Server einsetzbar, allerdings hängt die Funktion dann von der Erreichbarkeit des Servers ab.

Die Bereitstellung und der Support für Schnittstellen erfolgt gemäß unserer Angebotskonditionen und erfordert zumeist eine Geheimhaltungsvereinbarung. Bitte wenden Sie sich bei Fragen an unseren Support! Änderungen/Weiterentwicklungen und Einstellungen sind möglich. Für einen Demo-Zugriff (Schnittstellen-Tests) wenden Sie sich bitte an unseren Support.

 

Versionierung

DatumVersionÄnderung
06.11.193.8.50

getGpsHistory Abfrage mit neuen Parameter für Startdatum und Enddatum

getGpsHistory Antwort mit neuen Feldern (Temperatur, analoger Eingang)

driver/create Aufruf für das Anlegen/Ändern von Fahrern

building_site_codes Aufruf für das Anlegen/Ändern/Löschen von Projekt-Codes





Wie greift man auf die API zu

Um auf die API zuzugreifen wird der selbe Link verwendet, der auch zum Einloggen als normaler User in unsere Software verwendet wird. Für jeden Zugriff ist eine Verifikation notwendig, die über Username und Passwort oder einen API Schlüssel, der in der Software verfügbar ist, erfolgt. Das einfachtse Anwendungsbeispiel ist die Überprüfung ob ein User zur Software zulässig ist. In diesem Fall würde der Aufruf so aussehen:

http://gfs2.sw-management.at/GFS/api/std/checkuser?apikey=user----password

oder

http://gfs2.sw-management.at/GFS/api/std/checkuser?apikey=apikey

Der APIKEY wird im Softare-Zugang bei den Optionen gesetzt und kann auch verändert werden.

Die Antwort wird dann je nachdem ob der User akzeptiert wird so aussehen:

{"info":"ok"} or {"error":"100"}

Wo findet man die verschiedenen Aufrufe und Parameter

Alle Möglichkeiten , Daten von unserem System abzurufen bzw zu unserem System zu schicken, findet man in einem zentralen XML Dokument, das alle Informationen enthält wie notwendige und optionale Parameter und deren Typ.

Das WADL-Dokument mit dem ganzen Überblick ist hier zu finden: http://gfs2.sw-management.at/GFS/api/application.wadl (oder wenn die GFS auf einem anderen Server läuft unter Serverlink/api/application.wadl).

Zum Beispiel der checkuser Aufruf, der oben zu sehen ist, würde so in unserem application.wadl aussehen:

<resource path="/std">
 <resource path="/checkuser">
 <method id="checkuser" name="GET">
 <request>
<param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="apikey" style="query" type="xs:string"/>
</request>
 <response>
<representation mediaType="application/json"/>
</response>
</method>
</resource>

Grundlegende Aufrufe und Beispiele

Die grundlegendsten Aufrufe befinden sich unter masterdata. Unter masterdata sind weitere Unterpunkte für verschiedene Objekte die unser Server bereitstellen kann. Zum Beispiel asset, geofence oder driver. Die grundlegendsten Aufrufe werden so aussehen:

http://XXX.sw-management.at/GFS/api/masterdata/asset/getAssets?apikey=user----password,

http://XXX.sw-management.at/GFS/api/masterdata/geofence/getGeofences?apikey=user----password or

http://XXX.sw-management.at/GFS/api/masterdata/driver/getDrivers?apikey=user----password

 

Fahrzeugstammdaten abrufen

Mit dem folgenden Aufruf wird abgefragt, welche Geräte im Kunden-Account verfügbar sind. Wichtig ist der Fahrzeugname und die Geräte-Nummer (assetid) für weitere Abfragen.

https://XXX.sw-management.at/GFS/api/masterdata/gps/getAssetStates?apikey=ENTERYOURSECID&langid=2

xxx ... mit richtigen Zugangsdaten ersetzen

ENTERYOURSECID ... mit der Sicherheitsnummer für den Kunden-Account ersetzen (gesetzt vom Support in den Account-Optionen).


Aktuelle Fahrzeugpositionen abrufen

https://XXX.sw-management.at/GFS/api/masterdata/gps/getLastpos_for_assetid?apikey=ENERYOURSECID&assetid=YYYY

xxx ... mit richtigen Zugangsdaten ersetzen

ENTERYOURSECID ... mit der Sicherheitsnummer für den Kunden-Account ersetzen (gesetzt vom Support in den Account-Optionen).

YYYY ... assetid (siehe Abfrage Fahrzeugstammdaten)


Historische Rohdaten (Fahrspur) abrufen

https://XXX.sw-management.at/GFS/api/masterdata/gps/getGpsHistory?apikey=xmlYYYYYYYYYYY&opt_assetid_filter=XXX&opt_datestr_from_yyyyMMddhhmmss=20191015000000&opt_datestr_to_yyyyMMddhhmmss=20191016000000

xxx ... mit richtigen Zugangsdaten ersetzen

ENTERYOURSECID ... mit der Sicherheitsnummer für den Kunden-Account ersetzen (gesetzt vom Support in den Account-Optionen).

Aktuelle Fahrer abrufen

https://XXX.sw-management.at/GFS/api/masterdata/driver/getDrivers?apikey=ENTERYOURSECID

Fahrer anlegen

Mittels Post-Aufruf können Fahrer angelegt werden

https://XXX.sw-management.at/GFS/api/masterdata/driver/create?apikey=ENTERYOURSECID

 

{

    "shortname": "maxm",

    "username": "Max Maier",

    "mobile": "mobile number, not required",

    "email": "test@example.com",

    "password": "Max Maier"

}

Fahrtenbuch-Einträge abfragen

https://XXX.sw-management.at/GFS/api/masterdata/logbook/getLogbookData_for_assetid?apikey=ENTERYOURSECID&assetid=YYYY&showprivate=true&trips=true&stops=false&opt_datestr_from_yyyyMMddhhmmss=20171013000000


Fahrtenbuch-Projekt-Codes anlegen (Projekt-Codes)

Mittels Post-Aufruf können Projekt-Codes angelegt werden

https://XXX.sw-management.at/GFS/api/masterdata/logbook/building_site_codes?apikey=ENTERYOURSECID

 

                codes: [

                               {

                                               code: "B1917",

                                               title: "Großmarkt",

                                               address: "9999 Klöszß, Bahnhof 13",

                                               from: 1571664554000,

                                               to: 1572684554000,

                                               people: [163,164]

                               }

                ],

                toDelete: []


Weitere Aufrufe

modify

time

masterdata

bin

odr


Aufruf für den Versand von Touren

Der folgende Aufruf erstellt eine Tour mit 2 Kunden-Adressen, die an ein Fahrzeug/einen Fahrer geschickt werden. Weitere Felder (Extra-Daten) können optional hinzugefügt werden (siehe wadl).

https://uat.sw-management.at/GFS/api/email_job/email_sendJobAddress?apikey=xml1618924879-2204044689549486811-6442706128315387993&assetid=102&sendstore_also_if_unrouted_stops=true&tourname=json35&store=true&send=true&custnames_xx99xx_separated=Kunde19xx99xxKunde20&custaddresses_xx99xx_separated=8200%20Albersdorf%20209Gleisdorfxx99xx8160%20Weiz%20Schmied%20in%20der%20Weiz%20146&opt_personid=402

Liefert die Tourstops direkt an den Fahrer.

Achtung, beim Testaufruf muss der Tourname immer geändert werden!