Webservice/API-Zugriff
Allgemeines
Viele Daten dieser Website können direkt über eine HTTP-Schnittstelle abgefragt werden. Bisher wird die Suche nach Wörtern, Teilwörtern und nach ähnlich geschriebenen Wörtern unterstützt. Nicht unterstützt wird die Wikipedia/Wiktionary-Suche.
Hinweis: Die Nutzung der API ist kostenlos, aber es gelten folgende Bedingungen:
- Wir erwarten einen Link auf www.openthesaurus.de (ohne nofollow-Attribut). Sollten die Daten nur im Hintergrund benutzt werden (z.B. zur Erweiterung einer Suchanfrage o.ä.) reicht auch ein Hinweis im Impressum. Ansonsten sollte der Link für die Nutzer gut sichtbar auf der Seite angezeigt werden, auf der auch die Daten zum Einsatz kommen.
- Jede Anfrage muss im User-Agent-Header eine Kontaktmöglichkeit (z. B. Homepage oder E-Mail) enthalten, damit wir bei Problemen wissen, mit wem wir Kontakt aufnehmen können.
- Anfrage-Limitierung: Bei mehr als 60 Anfragen pro Minute von der gleichen IP-Adresse folgt eine Fehlermeldung. Zusätzlich zur direkten Abfrage stehen weiterhin Downloads der Datenbank zur Verfügung. Statt Massenabfragen über die API sollte dieser Download genutzt werden.
- Wer plant, die API dauerhaft zu benutzen, sollte sich bitte vorher bei feedback at openthesaurus.de melden. Nur so können wir rechtzeitig alle Nutzer kontaktieren, um zum Beispiel über mögliche Änderungen am Ausgabeformat zu informieren.
Suchanfrage für JSON
Mit der folgenden HTTP-Anfrage via GET können alle Synonymgruppen, die das Wort test beinhalten, abgefragt werden:
Kommt im Suchwort ein Sonderzeichen vor, muss es mit UTF-8 URL-kodiert werden (z.B. wird hören zu h%C3%B6ren).
Suchanfrage für XML
Statt application/json kann text/xml angegeben werden, um das Ergebnis im XML-Format zu erhalten.
Optionen
Bekannte Probleme
Umlaute werden bei der Suche wie ihre nicht-Umlaute behandelt, so findet tur auch den Eintrag zu Tür und umgekehrt.