WORTLIGA Textanalyse API

Mit der API der WORTLIGA Textanalyse kannst Du Texte automatisch analysieren lassen. Die API steuerst Du mit CURL an, wonach sie Ergebnisse im JSON Format zurückliefert. Dafür musst Du den API-Key und die E-Mail-Adresse Deines Textanalyse-API-Accounts verwenden.

Du hast noch keinen Textanalyse-API-Account? Dann schreibe formlos an kontakt@wortliga.de und wir schicken Dir zeitnah einen kostenlosen Testaccount.

API-URL bzw. CURL-Ziel

https://wortliga.de/textanalyse/api.php

POST-Parameter

username – Die Email Adresse Deines Textanalyse API Accounts
apiKey – Den API-Key Deines Textanalyse API Accounts
text – Der Text, den Du analysieren willst, ohne HTML-Tags und ohne Steuerzeichen wie   oder &. Newlines müssen mit \n angezeigt werden. Pro API-Call werden maximal 50.000 Zeichen analysiert.

Return

Verbessungswürdige Teile Deines Textes werden im JSON Format zurückgeliefert. Jeder gefundene Verbesserungsvorschlag hat eine eigene Kategorie, wie zum Beispiel:
SENTENCE_TOO_LONG, SENTENCE_LONG, WORD_TOO_LONG, PERFECT, PASSIVE, PHRASE, IMPERSONAL, MODAL_VERB, NOMINAL, FILLER_WORD, FORMAT_ERROR, SHORTCUT und WORD_REPETITION.
Wobei die Kategorie ‚WORD_REPETITION‘ besonders ist, da sie keinen speziellen Punkt im Text hat, sondern alle entsprechenden Wörter im Text betrifft. Ein JSON Antwort-Beispiel findest Du unten auf der Seite.

Außerdem bekommst Du noch praktische Statistiken zu Deinem Text:
Anzahl Sätze, Anzahl Wörter, Anzahl Buchstaben, Anzahl Zeichen, Anzahl Absätze, Geschätzte Lesedauer, Anzahl Absätze und den Lesbarkeitsindex nach Flesch-Kincaid.

PHP Beispiel:

$apiKey = '76C3FAB4DAVVC6C472D0606486109EAA'; // TODO: API-Key eintragen
$account = 'deine@email.de'; // TODO: Wortliga Account Email Adresse eintragen
$textToCheck = 'Man kann TExte mit dieser API verbessern.'; // TODO: Text eintragen

$ch = curl_init( 'https://wortliga.de/textanalyse/api.php' );
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'username=' . urlencode($account) . '&apiKey=' . $apiKey . '&text=' . urlencode($textToCheck));
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

$response = curl_exec($ch);
curl_close($ch);
echo $response;

Dieser CURL-Aufruf generiert folgende JSON-Antwort:

{
  "software": {
    "name": "Wortliga Textanalyse API",
    "version": "2019.08.16.0"
  },
  "statistics": {
    "sentences": 1,
    "words": 7,
    "letters": 34,
    "characters": 41,
    "paragraphs": 1,
    "timeToRead": "00:00:02",
    "fleschKincaidScore": 72
  },
  "matches": [
    {
      "text": "Man",
      "offset": 0,
      "length": 3,
      "rule": {
        "id": "IMPERSONAL",
        "description": "Unpersönliche Sprache"
      },
      "shortMessage": "Vermeide unpersönliche Sprache",
      "message": "Gerade im Web ist die persönliche Ansprache Deiner Leser wichtig. So interessiert sich der Leser noch mehr für Deinen Text, denn er identifiziert sich mit den Inhalten – er fühlt sich direkt angesprochen. Wandle unpersönliche Aussagen so oft wie möglich in direkte Ansprache um."
    },
    {
      "text": "TExte",
      "offset": 9,
      "length": 5,
      "rule": {
        "id": "FORMAT_ERROR",
        "description": "Formatierungsfehler"
      },
      "shortMessage": "Formatierungsfehler",
      "message": "Verbirgt sich hier ein Tippfehler oder ein falsch gesetztes Leerzeichen?"
    }
  ] }

Stand: 26.08.2019