[mitchatten]

Nickinfo

URL

Die URL für den Zugriff auf Nickinfo lautet:

https://api.relay-chat.de/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 https://api.relay-chat.de/2/nickinfo/hexa/json/ | jsonpretty
{
  "izsmart": {
    "ajax": false,
    "cache": false,
    "cache_hash": "90a883-5e3fb5d9299c",
    "cache_online": true,
    "mobile": false,
    "runtime": 0.06041,
    "time": 1389292325,
    "version": "tiberius/2.0.60@production"
  },
  "nickinfo": {
    "away": false,
    "awaymsg": "",
    "bot": false,
    "chan_count": 3,
    "chan_list": [
      {
        "channel": "#fachinformatiker.de",
        "status": 5,
        "status_clear": "Founder"
      },
      {
        "channel": "#iZ-smart",
        "status": 5,
        "status_clear": "Founder"
      },
      {
        "channel": "#linux",
        "status": 3,
        "status_clear": "Operator"
      }
    ],
    "connecttime": 1387386219,
    "gecos": "Christian Boenning",
    "helpop": true,
    "hostname": "netadmin.iZ-smart.net",
    "ident": "hexa",
    "ircop": true,
    "nick": "hexa",
    "online": true,
    "registered": true,
    "secure": true,
    "server": "noctem.iZ-smart.net",
    "services": false
  }
}

Payload

Der Status des Nutzers kann folgende Werte annehmen:

Formate abweichend von JSON

vCard

Die vCard wird wie folgt angesprochen: https://api.relay-chat.de/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: https://api.relay-chat.de/2/nickinfo/:nickname/png/ bzw. https://api.relay-chat.de/2/nickinfo/:nickname/dot/

Ausgegeben wird folgendes:

bzw.