vcg_api_golfclubs
Die Extension stellt über die eID vcgApiActiveGolfclubs eine Liste der freigeschalteten Golfclubs für die Aktion "gemeinsam golfen" bereit.
Authentifizierung
Es stehen zwei Möglichkeiten zur Verfügung.
-
Ein Token mit einem vorab kommunizierten Default-Wert.
http://www.domain.de/index.php?eID=vcgApiActiveGolfclubs&token=DEFAULT-TOKEN
-
Ein SHA1 Hash-Wert, errechnet aus einem unter den Parteien vereinbarten String und einem Seed bestehend aus dem aktuellen Datum: VEREINBARTER-STRING-d-m-Y. Um diesen Parameter einzusetzen, kann der Aufrufer bspw. folgende Funktion in PHP nutzen.
Beispiel:
$sha1Seed = new \DateTime();
$sha1Value = sha1('VEREINBARTER-STRING' . $sha1Seed->format('d-m-Y'));
Der ermittelte SHA1 muss im API-Aufruf im Parameter "hashval" angegeben werden.
Beispiel:
http://www.domain.de/index.php?eID=vcgApiActiveGolfclubs&hashval=51c9d4781b991efda9cabefc6178a9279edf70f342
Ausgabe
Eine Liste der freigeschalteten Golfclubs mit ihren jeweiligen DGV-Nummern wird als Array in JSON-Notation ausgegeben.
Beispiel:
[101,102,103,...]
Als für die Aktion freigeschaltet gelten alle Clubs, die folgende Bedingung erfüllen:
Tabelle fe_users, Spalte tx_femanager_confirmedbyuser = 1, Spalte usergroup = 2
Fehlermeldungen
Im Falle einer Fehlermeldung, sieht die Ausgabe der Extension folgendermaßen aus.
{"data":"BIN\/ERROR CODE Please contact your system administrator with this error code.","error":true}
Folgende Error Codes sind implementiert.
-
BIN/FTK Please contact your system administrator with this error code.
Der Wert des Default-Tokens weicht vom bekannten Wert ab.
-
BIN/HVF Please contact your system administrator with this error code.
Der übermittelte Hash-Wert war nicht korrekt errechnet. (Korrekter vereinbarter String plus das aktuelle Datum im Format d-m-Y)
-
BIN/VCD Please contact your system administrator with this error code.
Die Authentifizierung ist fehlgeschlagen.
-
BIN/NOG Please contact your system administrator with this error code.
Die Seiten-PID mit den bekannten Golfclubs war nicht korrekt, oder es gab keine Übereinstimmung der Suchkriterien (Siehe Abschnitt Ausgabe > Bedingung)
-
BIN/PID Please contact your system administrator with this error code.
Die Seiten-PID mit den fe_users Datensätzen ist entweder nicht vorhanden oder inkorrekt.
pixelgenau GmbH - 02.11.2016 ES - vcg_api_golfclubs / README.md
