Forum

Hallo,
ich habe Verständnisprobleme was die Nutzung Ihrer API betrifft. Was ist apiutils.php und wo finde ich es? Wie müssen die API-Anfragen z.B. in PHP aufgebaut sein? Ich würde gerne im ersten Schritt eine einfache Verbindung erzeugen und die generelle Funktionalität der API testen. Im zweiten Schritt möchte ich dann unseren Adressstamm in Ihr System übertragen. Wie muss ich hierfür vorgehen?

Danke und freundliche Grüße!

Hallo,

die APIUtils werden per se nicht benötigt, um die unter https://www.gpsauge.de/anbindung/api dokumentierte GPSoverIP API zu verwenden. Sie kann ganz einfach über HTTP-Requests mit entsprechenden Parametern (z.B. module, action, user, device, ...) aufgerufen werden.

So kann zum Beispiel die Liste aller GPSaugen eines GPS-Accounts über die folgende URL abgerufen werden:

https://www.apioverip.de/?module=devices&action=list&user=[IHR_GPS-ACCOUNT]&pwd=[IHR_GPS_ACCOUNT_PASSWORT]&nozlib=1&format=json

Bitte beachten Sie die Platzhalter in eckigen Klammern, die natürlich entsprechend ersetzt werden müssen.

Parameter-Tipp:
- nozlib=1|0 aktiviert/deaktiviert die GZip-Komprimierung der Antwort (Empfehlung: 1)
- format=json liefert die Antwort im Ausgabeformat JSON

Speichern einer Adresse:

Zum speichern einer Adresse gehen Sie bitte wie folgt vor:

POST-Request an https://www.apioverip.de, z.B. via CURL

Key-Value Parameter:

module:geoobject
action:set
nozlib:1 1 = Response ohne zusätzliche GZip-Komprimierung (empfohlen)
format:json Response im JSON-Format
user:[IHR_GPS-ACCOUNT]
pwd:[IHR_GPS_ACCOUNT_PASSWORT]
type:address
name:R1BTb3ZlcklQIEdtYkg= Matchcode, Pflichtfeld, base64, frei wählbare Bezeichnung, z.B. der Firmenname
address1:R1BTb3ZlcklQIEdtYkg= Firmenname, optional, base64, frei wählbar
street:SGF1cHRiYWhuaG9mc3RyYd9l Straßenname, Pflichtfeld, base64
housenumber:2 Hausnummer, Pflichtfeld, base64
city: U2Nod2VpbmZ1cnQ= Stadt, Pflichtfeld, base64
code:97424 Postleitzahl, Pflichtfeld, base64
country:DE Land, Pflichtfeld, base64
uniqueid:QUJDMTIzLTQ1Ng== Externe ID, optional, base64, frei wählbar. Hier können Sie die ID der Adresse Ihres Systems angeben
geoobjectid:195429487 ID des GEO-Objekts, optional. Gesetzt: GEO-Objekt mit dieser ID wird aktualisiert, nicht gesetzt: Ein neues GEO-Objekt wird angelegt

Response:

{
"return": -1,
"success": true,
"data": {
"id": 195429487
}
}

Die unter "data" zurückgegebene ID kann dann verwendet werden, um das erzeugte GEO-Objekt nachträglich zu verändern (siehe oben) oder zu löschen (via geoobject->delete).

Auflisten aller Adressen:

Um eine Liste aller gespeicherten Adressen zu erhalten gehen Sie bitte wie folgt vor:

GET-Request https://www.apioverip.de?module=geoobject&action=list&type=address&nozlib=1&format=json&user=[IHR_GPS-ACCOUNT]&pwd=[IHR_GPS_ACCOUNT_PASSWORT]

Löschen einer Adresse:

Um eine gespeicherten Adresse zu löschen gehen Sie bitte wie folgt vor:

GET-Request https://www.apioverip.de?module=geoobject&action=delete&geoobjectid=195429487&nozlib=1&format=json&user=[IHR_GPS-ACCOUNT]&pwd=[IHR_GPS_ACCOUNT_PASSWORT]

Bitte beachten Sie: Sofern Sie beabsichtigen, initial sehr viele Adressen auf diese Weise anzulegen, empfehle ich Ihnen, eine kurze "Verschnaufpause" von vielleicht 500 - 1000 Millisekunden (gerne auch mehr) zwischen die einzelnen Requests zu geben, da es sonst passieren könnte, dass Sie von unseren API-Sicherheitsmechanismen wegen zu hoher Anzahl an Anfragen in zu kurzer Zeit geblockt werden.

Beste Grüße,
Ihr GPSoverIP Team