[mitchatten]

Virtuelle Hosts

URL

Die URL um einen vHost zu erstellen lautet:

https://api.relay-chat.de/2/vhost/

Ansprechen lässt sich diese URL per HTTP POST sowie per HTTP GET.

Die Route hat pinzipiell zwei Arbeitsweisen. Es lassen sich virtuelle Hosts anlegen (set) und löschen (del).

Wir verwenden diese Funktion innerhalb unseres vHost Interfaces.

Parameter

vHost erstellen

Die Route akzeptiert zum erstellen eines vHost folgende Parameter:

Der vollständige vHost wird sich im folgenden aus host und tld in der Form host.tld zusammensetzen.

Nach erfolgreichem Erstellen des virtuellen Hosts wird mittels MemoServ im IRC eine Nachricht an den übergebenen Nicknamen versendet.

$ curl -XPOST -d "command=set&nickname=hexa&password=************&host=example&tld=com" https://api.relay-chat.de/2/vhost/ | jsonpretty
{
  "izsmart": {
    "ajax": false,
    "cache": false,
    "cache_hash": "1a2a13-d4bd3fe3b4b3",
    "cache_online": true,
    "mobile": false,
    "runtime": 0.0032,
    "time": 1389541420,
    "version": "tiberius/2.0.65@production"
  },
  "vhost": {
    "host": true,
    "nickserv": true,
    "ok": true,
    "tld": true
  }
}

vHost löschen

Die Route akzeptiert zum löschen eines vHost folgende Parameter:

$ curl -XPOST -d "command=del&nickname=hexa&password==************" https://api.relay-chat.de/2/vhost/ | jsonpretty
{
  "izsmart": {
    "ajax": false,
    "cache": false,
    "cache_hash": "1a2a13-d4bd3fe3b4b3",
    "cache_online": true,
    "mobile": false,
    "runtime": 0.00314,
    "time": 1389541450,
    "version": "tiberius/2.0.65@production"
  },
  "vhost": {
    "host": null,
    "nickserv": true,
    "ok": true,
    "tld": null
  }
}

Payload

Ist der Wert von vhost.ok true ist davon auszugehen das der vHost gesetzt wurde. Im Fehlerfall wird bei allen Werten false zurückgegeben.

Top Level Domains

Die Route akzeptiert ausschließlich gültige bzw. vorhandene Top Level Domains. Die Liste der akzeptierten Top Level Domains ist abrufbar unter https://api.relay-chat.de/2/tldlist/ (es wird JSON oder YAML zurückgegeben).