Schlagwort-O-Mat

Programmierschnittstelle

Selbstverständlich besitzt der Schlagwort-O-Mat eine Programmierschnittstelle, damit coole Menschen mit den Daten dieser Webapplikation coole Programme schreiben können.

Die Syntax der API-Invokation hat sich seit dem letzten Update nicht geändert (Stand: 01.12.2012).

http://schlagwort.max-grossmann.de/api.php?[base64-Wort]

Wie hier offensichtlich ist, wird an die Stamm-URL nach einem Fragezeichen das gewünschte Wort angehängt. Das Wort muss base64-enkodiert sein, damit alle Zeichen – also auch Umlaute – ihren richtigen Weg finden.

Das Ausgabeformat ist XML. Beispiele: 1, 2, 3

Es gibt auch eine Plaintext-API, deren Verwendung ich empfehle, da Plaintext besser als XML ist, weil es zum Beispiel einfacher zu parsen und sparsamer ist. Das ist auch der Grund, warum diese API am häufigsten genutzt wird. Die Syntax lautet:

http://schlagwort.max-grossmann.de/xapi.php?[base64-Wort]

Der gleiche Witz wie oben mit base64. Beispiele: 1, 2, 3

Es ist auch möglich, die tagesaktuellen Top-100-Schlagwörter zu erhalten. Die URL hierfür lautet:

http://schlagwort.max-grossmann.de/jsondump.php

Das Format ist JSON.
Es gibt auch hierfür eine Top-100-Plaintext-API, deren Verwendung ich empfehle.

http://schlagwort.max-grossmann.de/xdump.php

Wichtige Hinweise zur Verwendung der APIs

  1. Alle Aufrufe der APIs sind gecached. Das heißt, dass es prinzipiell egal ist, wie viele Aufrufe getätigt werden, die Datenbank wird es nicht kümmern.
  2. Es muss ein User-Agent mitgesandt werden. Dieser User-Agent darf nicht die Zeichenkette »Java« enthalten.
  3. Jedes Programm, das die API nutzt, sollte Freie Software oder zumindest »Open Source« sein. Das ist kein Zwang, aber es ist gerner gesehen.
  4. Die Daten sind nicht urheberrechtlich geschützt.