Inhaltsverzeichnis

Live Portal API

Live Portal API

Mit Hilfe der API-Schnittstelle, können Sie Zugriff auf alle Objekte und Informationen aus unserem Live Portal erhalten.

Der Zugriff auf die API erfolgt verschlüsselt über eine HTTPS-URL

 Beispiel: [[https://portal.gps-watch.de/api/api.php|https://portal.gps-watch.de/api/api.php]]

Auch die API-Version sollte in der HTTPS-URL festgelegt werden

 Beispiel: [[https://portal.gps-watch.de/api/api.php?api=user&ver=1.0|https://portal.gps-watch.de/api/api.php?api=user&ver=1.0]]

Die API-Authentifizierung erfolgt über Ihren persönlichen API-Schlüssel

 Beispiel: [[https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC|https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC]]

Ihren API-Schlüssel erhalten sie auf Anfrage beim Support via E-Mail unter support@gps-watch.de

API

USER_GET_OBJECTS

Objektliste des aktuellen Benutzerkontos abrufen

Variabel	Wert
Command	USER_GET_OBJECTS

 Beispiel: [[https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=USER_GET_OBJECTS|https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=USER_GET_OBJECTS]]

OBJECT_GET_CMDS

Ruft Objektbefehle ab, die zur Ausführung gesendet wurden.

Variabel	Wert
Command	OBJECT_GET_CMDS
Parameter #1	Object IMEI

 Beispiel: [[https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=OBJECT_GET_CMDS,11111111111111|https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=OBJECT_GET_CMDS,11111111111111]]

OBJECT_CMD_GPRS

Senden Sie einen ASCII- oder HEX-Befehl über das GPRS-Gateway an das Objekt.

Variabel	Wert
Command	OBJECT_CMD_GPRS
Parameter #1	Object IMEI
Parameter #2	Command name
Parameter #3	Type (HEX or ASCII)
Parameter #4	Command, if command type is ASCII it is important to use quotes (")

 Beispiel: https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=OBJECT_CMD_GPRS,111111111111111,TEST,ASCII,"COMMAND_TEXT"

 Beispiel: [[https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=OBJECT_CMD_GPRS,111111111111111,TEST,HEX,AABBCC|https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=OBJECT_CMD_GPRS,111111111111111,TEST,HEX,AABBCC]]

OBJECT_CMD_SMS

Senden Sie einen SMS-Befehl über das SMS-Gateway an das Objekt.

Variabel	Wert
Command	OBJECT_CMD_SMS
Parameter #1	Object IMEI
Parameter #2	Command name
Parameter #3	Command, it is important to use quotes (")

 Beispiel: https://portal.gps-watch.de/apiapi.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=OBJECT_CMD_SMS,111111111111111,TEST,"COMMAND_TEXT"

OBJECT_GET_LOCATIONS

Abrufen der zuletzt bekannten Standortdaten von Objekten im JSON-Format.

Variabel	Wert
Command	OBJECT_GET_LOCATIONS
Parameter #1	Object IMEI, for multiple IMEIs separate them via semicolon. Use "*" to get all available object locations.

 Beispiel: [[https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=OBJECT_GET_LOCATIONS,111111111111111;222222222222222|https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=OBJECT_GET_LOCATIONS,111111111111111;222222222222222]]

 Beispiel: [[https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=OBJECT_GET_LOCATIONS|https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=OBJECT_GET_LOCATIONS]],*

OBJECT_GET_ROUTE

Ruft Informationen zur Objektroute ab, einschließlich Stopps und Ereignissen für einen festgelegten Zeitraum im JSON-Format.

Variabel	Wert
Command	OBJECT_GET_ROUTE
Parameter #1	Object IMEI
Parameter #2	Date and time from, format: YYYY-MM-DD HH:MM:SS
Parameter #3	Date and time to, format: YYYY-MM-DD HH:MM:SS
Parameter #4	Minimal stop duration in minutes (1, 2, 5, 10, 20, 30, 60, 120, 300)

 Beispiel: [[https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=OBJECT_GET_ROUTE,111111111111111,2016-01-01|https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=OBJECT_GET_ROUTE,111111111111111,2016-01-01]] 00:00:00,2016-02-01 00:00:00,1

OBJECT_GET_MESSAGES

Nachrichten abrufen über die Objektposition für einen festgelegten Zeitraum im JSON-Format.

Variabel	Wert
Command	OBJECT_GET_MESSAGES
Parameter #1	Object IMEI
Parameter #2	Date and time from, format: YYYY-MM-DD HH:MM:SS
Parameter #3	Date and time to, format: YYYY-MM-DD HH:MM:SS

 Beispiel: [[https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=OBJECT_GET_MESSAGES,111111111111111,2016-01-01|https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=OBJECT_GET_MESSAGES,111111111111111,2016-01-01]] 00:00:00,2016-02-01 00:00:00

OBJECT_GET_EVENTS

Ruft Objektereignismeldungen für einen festgelegten Zeitraum im JSON-Format ab.

Variabel	Wert
Command	OBJECT_GET_EVENTS
Parameter #1	Object IMEI
Parameter #2	Date and time from, format: YYYY-MM-DD HH:MM:SS
Parameter #3	Date and time to, format: YYYY-MM-DD HH:MM:SS

 Beispiel: [[https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=OBJECT_GET_EVENTS,111111111111111,2016-01-01|https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=OBJECT_GET_EVENTS,111111111111111,2016-01-01]] 00:00:00,2016-02-01 00:00:00

OBJECT_GET_LAST_EVENTS

Ruft alle Objektereignisse der letzten 24 Stunden im JSON-Format ab.

Variabel	Wert
Command	OBJECT_GET_LAST_EVENTS

 Beispiel: [[https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=OBJECT_GET_LAST_EVENTS|https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=OBJECT_GET_LAST_EVENTS]]

USER_GET_MARKERS

Alle Adressen des aktuellen Benutzerkontos abrufen.

Variabel	Wert
Command	USER_GET_MARKERS

 Beispiel: [[https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=USER_GET_MARKERS|https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=USER_GET_MARKERS]]

USER_GET_ROUTES

Alle Routen des aktuellen Benutzerkontos abrufen.

Variabel	Wert
Command	USER_GET_ROUTES

 Beispiel: [[https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=USER_GET_ROUTES|https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=USER_GET_ROUTES]]

USER_GET_ZONES

Alle Geozäune des aktuellen Benutzerkontos abrufen.

Variabel	Wert
Command	USER_GET_ZONES

 Beispiel: [[https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=USER_GET_ZONES|https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=USER_GET_ZONES]]

GET_ADDRESS

Alle Adressen mit Breiten- und Längengraden über denn Server-Geocoder abrufen.

Variabel	Wert
Command	GET_ADDRESS
Parameter #1	Latitude
Parameter #2	Longitude

 Beispiel: [[https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=GET_ADDRESS,54.684314,25.285398|https://portal.gps-watch.de/api/api.php?api=user&ver=1.0&key=ABCABCABCABCABC&cmd=GET_ADDRESS,54.684314,25.285398]]

Authentifizierung

Die Authentifizierung über die API ermöglicht die Anmeldung am System über eine URL. Dies ermöglicht die Integration von Drittsoftware für Webseiten anderer Anbieter.

 Beispiel: [[https://portal.gps-watch.de/login.php?username=USERNAME&password=PASSWORD|https://portal.gps-watch.de/login.php?username=USERNAME&password=PASSWORD]]