iZ-smart.net API v2 – Nickinfo

Der Zugriff auf Nickinfo ist unter http://wwwapi.iZ-smart.net/2/nickinfo/[:nickname]/[:format]/ möglich. Für Zugriff via HTTP GET ist hier die Reihenfolge der Parameter wichtig. Ist ein Nutzer nicht online wird ein leeres JSON bzw. XML Objekt zurückgegeben.

Parameter:

[:nick] => Der Nickname zu dem Informationen ausgegeben werden

[:format] => Das Format in dem Informationen ausgegeben werden. Aktuell bieten wir folgende Formate an: json (Default), xml, png, dot und vcard

Beispiel-URL (Output siehe Demo-Payload): http://wwwapi.iZ-smart.net/2/nickinfo/hexa/json/

Demo-Payload (JSON – gekürzt):

 1 {
 2   "izsmart":{
 3     "request": "18e96cc570bf08b6aae079de1c13b12df6b25999",
 4     "time": 1299337896,
 5     "version": "v0.49@tiberius",
 6     "nick": "hexa",
 7     "format": "json",
 8     "ajax": false,
 9     "mobile": false
10   },
11   "nickinfo":{
12     "nick": "hexa",
13     "gecos": "Christian Boenning",
14     "hostname": "netadmin.iZ-smart.net",
15     "ident": "hexa",
16     "server": "noctem.iZ-smart.net",
17     "connecttime": 1284902315,
18     "awaymsg": "",
19     "away": "N",
20     "online": "Y",
21     "registered": "Y",
22     "secure": "Y",
23     "bot": "N",
24     "ircop": "Y",
25     "helpop": "Y"
26   },
27   "channels":[
28     { "channel": "#fachinformatiker.de", "status": 1 },
29     { "channel": "#gondor", "status": 3 },
30     { "channel": "#iZ-smart", "status": 3 },
31     { "channel": "#linux", "status": 3 },
32     { "channel": "#unterwegs-im.net", "status": 3 }
33   ]
34 }

Payload-Erklärungen:

izsmart => Array
izsmart.request => eindeutige Request-ID
izsmart.time => Gibt an von wann genau die Daten sind
izsmart.version => gibt API Version und den antwortenden Server an
izsmart.nick => der Nickname für den Informationen abgerufen werden
izsmart.format => das Format in dem Informationen angefordert werden
izsmart.ajax => gibt an ob der Request per AJAX kam
izsmart.mobile => gibt an ob der Request von einem mobilen Gerät ausgeführt wurde
nickinfo => Array
nickinfo.nick => der Nickname mit dem der Nutzer tatsächlich online ist.
nickinfo.gecos => der Realname des Nutzers
nickinfo.hostname => der Hidden-Hostname des Nutzers
nickinfo.server => der Server auf dem der Nutzer verbunden ist
nickinfo.connecttime => seit wann der Nutzer auf dem Server verbunden ist (Unix-Timestamp)
nickinfo.awaymsg => eine mögliche /AWAY Message des Nutzers
nickinfo.away => ist der Nutzer /AWAY oder nicht
nickinfo.online => ist der Nutzer Online
nickinfo.registered => gibt an ob der Nickname bei NickServ registriert ist
nickinfo.secure => gibt an ob der Nutzer per SSL verbunden ist
nickinfo.bot => ist der Nutzer ein Bot
nickinfo.ircop => ist der Nutzer ein IrcOp
nickinfo.helpop => ist der Nutzer ein Helpdesk Mitglied / für Hilfe verfügbar
channels => Array
channels.channel => Channelname
channels.status => Status des Nutzers (5 = Owner, 4 = Admin, 3 = Operator, 2 = HalfOp, 1 = Voice, 0 = Nichts)

Formate abweichend von XML/JSON:

vCard:

Die vCard wird wie folgt angesprochen: http://wwwapi.iZ-smart.net/2/nickinfo/[:nick]/vcard/?channel=channel

Ausgegeben würde folgendes:

PNG / DOT

Die Online/Offline-Anzeige wird wie folgt angesprochen: http://wwwapi.iZ-smart.net/2/nickinfo/[:nick]/png/ bzw. http://wwwapi.iZ-smart.net/2/nickinfo/[:nick]/dot/