Page tree
Skip to end of metadata
Go to start of metadata

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 uns!

 

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=ENTERYOURSECID&limit=300

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

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

Weitere Aufrufe

modify

  • /logbook/set_operating_hours: diesen Befehl mit den Parametern apikey, assetid und new_h_value aufzurufen setzt einen neuen Wert für die Betriebsstunden eines Fahrzeugs.
  • /insertpos: diesen Befehl aufzurufen mit den Parametern apikey, assetid, lat, lng, d1, speed, ts_yyyyMMddhhmmss und optional opt_fuellevel setzt eine neue Position für ein Fahrzeug inklusive Zündung, Geschwindigkeit und der Zeit an der entsprechend Stelle und optional den Tankfüllstand.
  • /insertpos_address: diesen Befehl aufzurufen mit den Parametern apikey, assetid, address, d1, speed, ts_yyyyMMddhhmmss und optional opt_fuellevel setzt eine neue Position für ein Fahrzeug an der entsprechenden Adresse.

time

  • /start_time_record: diesen Befehl mit den Parametern apikey, start_ts_yyyyMMddhhmmss, personid und optional opt_assetid, opt_custid_geofenceid, opt_activityid, opt_commentstr, opt_lat, opt_lng und opt_address aufzurufen startet einen neuen Zeit Eintrag für die Person mit der angegeben Zeit als Startzeit und fügt optional das Fahrzeug, den Geofence, die Position, oder Adresse an der die Person arbeitet, einen Kommentar und die Aktivität die die Person ausführt entsprechend der optionalen Parameter.
  • /update_time_record:  diesen Befehl mit den Parametern apikey, end_ts_yyyyMMddhhmmss, personid und optional opt_assetid, opt_custid_geofenceid, opt_activityid, opt_commentstr, opt_lat, opt_lng and opt_address aufzurufen schließt den letzten Zeiteintrag für die Person mit der gegebenen Zeit ab und  fügt optional das benutzte Fahrzeug, den Geofence, die Position, oder die Adresse an der die Person gearbeitet hat, einen Kommentar und die Aktivität je nach den optionalen Parametern hinzu. Im Falle eines Fahrzeugs können die Anfangs- bzw Endpostition/-adresse unterschiedlich sein.
  • /insert_complete_time_record:  diesen Befehl mit den Parametern apikey, start_ts_yyyyMMddhhmmss, end_ts_yyyyMMddhhmmss, personid und optional opt_assetid, opt_custid_geofenceid, opt_activityid, opt_commentstr, opt_lat, opt_lng und opt_address  aufzurufen erzeugt einen kompletten Zeiteintrag mit der gegebenen Start- und Endzeit und wird optional das benutzte Fahrzeug, den Geofence, die Position, oder die Adresse an der die Person gearbeitet hat, einen Kommentar und die Aktivität je nach den optionalen Parametern hinzufügen.

masterdata

  • /data/getLastTimeRecord: dieser Befehl mit den Parametern apikey und personid gibt den letzten Zeiteintrag dieser Person zurück.
  • /data/getActivityTypes: diesen Befehl mit dem apikey aufzurufen gibt alle Aktivitäten des Accounts zurück.
  • /asset/getAssets_by_assetkey: diesen Befehl mit dem apikey und dem assetkey auszuführen gibt das Fahrzeug mit dem entsprechenden Schlüssel zurück. (Der Schlüssel muss in der GPS Fleet Software gesetzt werden und kann genutzt werden um auf ein Fremdsystem zu referenzieren)

bin

  • /upload: diesen Befehl aufzurufen erlaubt es eine Datei zum Server hochzuladen (in den meisten Fällen ein Bild). Wie immer wird der apikey als Parameter benötigt, optional können opt_relationID, opt_pkid, opt_category, opt_name, opt_commentinfo, opt_binid gesetzt werden um die Relation, das Objekt zu dem die Datei gehört, die Kategorie, der Name oder ein Kommentar hinzuzufügen, weiters kann eine existierende Datei über die binid überschrieben werden.

odr

  • /getDynDataValues: diesen Befehl aufzurufen mit dem apikey und optional opt_limit, opt_relationID oder opt_pkid zum filtern wird die dynamischen Felder des Accounts zurückgeben die vom User in der GPS Fleet Software erstellt und konfiguriert werden können und es erlauben zusätzliche Felder für Objekte zu setzten.
  • /setDynDataValue_for_pkid_defid_relationID: diesen Befehl mit den Parametern apikey, pkid, relationID, defid and one parameter of v_int, v_str, v_bigint, v_float, v_date_yyyyMMddhhmmss, v_boolean aufzurufen wird ein gegebenes Feld des gegebenen Objekts auf den gegebenen Wert ändern. Wichtig: der korrekte Paramater für den Wert muss verwendet werden um das Feld zu überschreiben.


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!


 

  • No labels