Nickinfo

URL

Die URL für den Zugriff auf Nickinfo lautet:

http://wwwapi.iZ-smart.net/2/nickinfo/:nickname/:format/?channel=:channel

Parameter

Die Parameter, die dieser URL übergeben werden können, sind nickname & format. Als weiterer Parameter (nur für das Format vCard) kann ein Channel übergeben werden.

Der Parameter nickname enthält den Nicknamen, zu dem die Informationen abgefragt werden sollen. Format kann folgende Werte annehmen: json, png, dot sowie vcard. Wird der Parameter format weggelassen, antwortet das API per Default im Format json.

$ curl http://wwwapi.iZ-smart.net/2/nickinfo/hexa/json/ | jsonpretty

{
  "izsmart": {
    "format": "json",
    "nick": "hexa",
    "ajax": false,
    "time": 1320170163,
    "mobile": false,
    "version": "v0.49@tiberius",
    "request": "c8aa522e3702f1028d10376cb7b45bfa4cd78830"
  },
  "nickinfo": {
    "registered": "Y",
    "gecos": "Christian Boenning",
    "connecttime": 1316940662,
    "nick": "hexa",
    "helpop": "Y",
    "secure": "Y",
    "server": "noctem.iZ-smart.net",
    "ident": "hexa",
    "bot": "N",
    "away": "N",
    "hostname": "netadmin.iZ-smart.net",
    "ircop": "Y",
    "online": "Y",
    "awaymsg": ""
  },
  "channels": [
    {
      "channel": "#fachinformatiker.de",
      "status": 5
    },
    {
      "channel": "#gondor",
      "status": 3
    },
    {
      "channel": "#iZ-smart",
      "status": 5
    },
    {
      "channel": "#linux",
      "status": 3
    },
    {
      "channel": "#unterwegs-im.net",
      "status": 4
    }
  ]
}

Payload

• 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
  • 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

Der Status des Nutzers kann folgende Werte annehmen:

• 5 = Owner
• 4 = Admin
• 3 = Operator
• 2 = HalfOp
• 1 = Voice
• 0 = kein Status

Formate abweichend von JSON

vCard

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

Im Channel-Name muss auch hier die führende # (Raute) weggelassen werden.

Ausgegeben würde folgendes:

PNG / DOT

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

Ausgegeben wird folgendes:

bzw.