Erweiterte API für Entwickler

[Webkicks]

Hallo zusammen,

wir haben die schon bestehenden Zugriffsmöglichkeiten per API stark erweitert, um Entwicklern den automatisierten Zugriff auf unterschiedliche Daten zu erleichtern. Falls sich die Programmierer unter unseren Nutzern weitere Möglichkeiten wünschen prüfen wir gerne die Machbarkeit, bitte einfach melden. Im Folgenden eine Übersicht über die neuen API Methoden.

Methoden die ohne Nutzername und Passwort aufgerufen werden können:

get_replacers:

Script:Zeigen

Code: Alles auswählen

{
":lache": "lache.gif",
":foto": "foto.jpg"
}

get_toplist (optional auch mit Nutzername und Passwort: liefert auch bei deaktivierter Top-Liste Daten):

Script:Zeigen

Code: Alles auswählen

{
    "Alex": {
      "seconds" : 7,
      "totalseconds" : "2377207",
      "hours" : "12",
      "minutes" : "20",
      "days" : "27"
    },
    "Max": {
      "seconds" : 35,
      "totalseconds" : "3047315",
      "hours" : "6",
      "minutes" : "28",
      "days" : "35"
    }
}

get_teamlist_json:

Script:Zeigen

Code: Alles auswählen

{
   "hauptadmin" : "Linus",
   "admins" : [
      "Dennis", "DG"
   ],
   "mods" : []
}

get_onlinelist_json:

Script:Zeigen

Code: Alles auswählen

{
   "sep.tester" : [
      {
         "profil" : "0",
         "awayreason" : "",
         "iconid" : "",
         "away" : "0",
         "rang" : "admin",
         "name" : "Tester"
      }
   ],
   "main" : [
      {
         "profil" : "0",
         "awayreason" : "",
         "iconid" : "",
         "away" : "0",
         "rang" : "admin",
         "name" : "Linus"
      }
   ]
}

Methoden die nur mit Nutzername und Passwort aufgerufen werden können:

get_sid:

Script:Zeigen

Code: Alles auswählen

{
"sid: "aDnkcE2uPRTjOzKvOxa0Kuxdl4yaGwP7moRkONLkkK8H74xODXwK"
}

Methoden die nur mit Nutzername und Passwort eines Admins aufgerufen werden können:

get_userdata:

Script:Zeigen

Code: Alles auswählen

{
   "profile" : "true",
   "points" : "0",
   "loginmessage" : "betritt den Chat",
   "lastseen" : "04.07.2020 [19:02]",
   "registered" : "04.70.2020 [19:00]",
   "username" : "Tester",
   "level" : "Chatter",
   "alias" : "<b><font color=\"red\">Tester</font></b>",
   "messenger" : "",
   "ip" : "22.33.44.*",
   "status" : "frei",
   "logoutmessage" : "verlässt den Chat",
   "mail" : "example@example.de",
   "logins" : "1",
   "hp" : "",
   "sex" : "m",
   "gbentries" : "0",
   "newsletter" : "true"
}

get_announcements:

Script:Zeigen

Code: Alles auswählen

{
"registered": "Hallo %USER%, du bist zum %CHATS%. mal im Chat!",
"team": "Danke für deine Mitarbeit im Team! :-)",
"guest": "Hallo %user%, wenn Du Dich registrierst hast Du tolle Möglichkeiten!"
}

get_allusers, get_kickedusers, get_bannedusers, get_lockedusers, get_mutedusers:

Script:Zeigen

Code: Alles auswählen

[
   "Alex",
   "Max",
   "Tester"
]

get_channels:

Script:Zeigen

Code: Alles auswählen

{
   "active" : "true",
   "onloginpage" : "true",
   "list" : [
      "Hauptchat",
      "Testraum"
   ]
}

get_settings:

Script:Zeigen

Code: Alles auswählen

{
   "google" : "true",
   "toplist" : "20",
   "guestwhisper_receive" : "true",
   "loginpage" : "",
   "guestwhisper_send" : "true",
   "webspace" : "true",
   "nobanner" : "1375966813",
   "login" : "true",
   "replacer" : "true",
   "showusernum" : "true",
   "showusers" : "true",
   "openreg" : "true",
   "owncmds" : "true",
   "guestaccess" : "true",
   "profiles" : "true"
}

get_reglog:

Script:Zeigen

Code: Alles auswählen

[
    {
      "timestamp" : "1350241078",
      "time" : "20:57",
      "date" : "14.10.2012",
      "deleted" : "true",
      "username" : "Alex"
    },
    {
      "timestamp" : "1349370052",
      "time" : "19:00",
      "date" : "04.10.2012",
      "deleted" : "false",
      "username" : "Max"
    }
]

get_cmdlog:

Script:Zeigen

Code: Alles auswählen

[
   {
      "timestamp" : "1353322161",
      "subject" : "Tester",
      "date" : "19.11.2012",
      "time" : "11:49",
      "action" : "knebel 1",
      "username" : "Webkicks"
   },
   {
      "timestamp" : "1353321936",
      "subject" : "Tester",
      "date" : "19.11.2012",
      "time" : "11:55",
      "action" : "bann",
      "username" : "Webkicks"
   }
]

get_invalidpasslog:

Script:Zeigen

Code: Alles auswählen

[
   {
      "timestamp" : "1353212029",
      "time" : "05:13",
      "date" : "18.11.2012",
      "IP" : "11.22.33.44",
      "username" : "Tester"
   },
   {
      "timestamp" : "1353212026",
      "time" : "05:13",
      "date" : "18.11.2012",
      "IP" : "11.22.33.44",
      "username" : "Tester"
   }
]

get_dellog:

Script:Zeigen

Code: Alles auswählen

[
   {
      "timestamp" : "1350911442",
      "time" : "15:10",
      "date" : "22.10.2012",
      "by" : "wk_autodel",
      "username" : "Alex"
   },
   {
      "timestamp" : "1341666333",
      "time" : "15:05",
      "date" : "07.07.2012",
      "by" : "Tester",
      "username" : "Max"
   }
]

Die schon bestehende API wurde um die Methoden erweitert, die API ist weiterhin unter http://serverX.webkicks.de/CHATNAME/api/METHODE erreichbar. Funktion, die Nutzername und Passwort benötigen, können via http://serverX.webkicks.de/CHATNAME/api/ADMINNAME/PASSWORT/METHODE aufgerufen werden. Für zusätzliche Parameter (Chattername bei get_userdata) wird noch ein /CHATTERNAME an die URL angehängt.

Optional kann die Rückgabe auch als JSONP (JSON mit Padding) erfolgen, wodurch es möglich ist, die Same-Origin-Policy zu umgehen. Der Aufruf sieht hier wie folgt aus:
http://serverX.webkicks.de/CHATNAME/api/METHODE?jsonp=Callback

Alternativ können die Parameter auch per "POST" übergeben werden, dafür bitte folgende Daten nutzen:
API: http://serverX.webkicks.de/CHATNAME/api
cid: Chatname
user: Adminname
pass: Passwort
job: Methode
message (optional): Zusätzlicher Parameter (z.B. für get_userdata)

Wir hoffen es finden sich einige schöne Anwendungsfälle für die neuen Funktionen

[1. FC Keller]

Hallo,

ich bastle gerade an einem neuen Projekt und wollte für den Anfang die JSONP-API nutzen um die Onlineliste abzufragen.
jQuery generiert automatisch relativ lange Funktions-Namen. Diese werden von der API ignoriert, z.B. https://server4.webkicks.de/wktools/api ... 2225073723

Die API nimmt offenbar nur jsonp Parameter mit bis zu 20 Zeichen an, während die jQuery getJSON Methode zufällige Funktionsnamen von (bei meinen Tests) 41 Zeichen länge generiert.

Wenn ich einen kürzeren Funktionsmanen von Hand eingebe funktioniert es.
Wäre es möglich die erlaubte Länge des Parameters auf vielleicht irgend etwas zwischen 41 und 50 zu erhöhen, sodass es mit jQuery funktioniert?

[Webkicks]

Erledigt, ab sofort sind bis zu 50 Zeichen erlaubt.