Nutzung der API

Vorgehensweise

Die Nutzung der API erfolgt mittels cURL-Zugriff auf die Datei http://goodurl.de/lib/api.php, wobei dieser Datei verschiedene Variable übergeben werden. Einige Variable sind dabei Pflichtvariable, die bei jedem Aufruf angegeben werden müssen. Diese werden im nachfolgenden Absatz beschrieben. Bei einzelnen Funktionen können dann weitere erforderliche Variable hinzukommen. Die Rückgabe der Variablen erfolgt stets in Form eines Strings. Dabei zeigt die Rückgabevariable error stets an, ob ein Fehler eingetreten ist (0=kein Fehler).

Pflicht-Variable

Folgende Variable sind bei jedem Aufruf mindestens zu übergeben:

user  (der Nutzername, mit dem Sie bei goodurl.de angemeldet sind)
pw  (das zu obigem Nutzernamen gehörige Passwort)
cmd  (der auszuführende Befehl / die auszuführende Funktion)

Hierzu kommen bei einzelnen Funktionen weitere erforderliche und/oder optionale Variablen. Diese, sowie die möglichen Rückgabewerte und Fehlernummern finden Sie bei der Dokumentation der einzelnen Funktionen.