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.

Fehlertypen

Verbessungswürdige Teile Deines Textes werden im JSON Format zurückgeliefert. Jeder gefundene Verbesserungsvorschlag hat eine eigene Kategorie. Hier findest Du alle Kategorien, die in der JSON-Antwort als „id“ im „matches“ Array vorkommen:

SENTENCE_LONG: zu lange Sätze
SENTENCE_TOO_LONG: viel zu lange Sätze
PASSIVE: Passiv
PERFECT: Perfekt
WORD_TOO_LONG: komplexe oder zu lange Wörter
PHRASE: Phrasen
IMPERSONAL: unspersönliche Sprache
MODAL_VERB: Modalverben
NOMINAL: Nominalstil
FILLER_WORD: Füllwörter
ADJECTIVE: Adjektive
FORMAT_ERROR: Formatierungsfehler
SHORTCUT: Abkürzungen
WORD_REPEAT: Wort wird in kurzem Abstand mehrmals verwendet
WORD_REPETITION: Wort macht mehr als 2 % des Textes aus

Die Kategorie ‚WORD_REPETITION‘ ist besonders, 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 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 und unseren eigenen Lesbarkeitsindex.

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": "2022.11.25.0"
},
"matches": [
{
"text": "Man",
"offset": 0,
"length": 3,
"rule": {
"id": "IMPERSONAL",
"description": "Unpersönliche Sprache"
},
"shortMessage": "Kannst Du Deinen Leser hier persönlich ansprechen?",
"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": "kann",
"offset": 4,
"length": 4,
"rule": {
"id": "MODAL_VERB",
"description": "Modalverben"
},
"shortMessage": "Modalverben sind meistens entbehrlich: Verwende besser direkte Verbformen",
"message": "Modalverben wie können, müssen oder sollen sind meistens entbehrlich und blähen Deinen Text unnötig auf. Verwende besser direkte Verbformen, um dem Leser Deine Informationen direkt und prägnant zu präsentieren. “Sie sollten auf eine gute Qualität achten” wird zu “Achten Sie auf eine gute Qualität”."
},
{
"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?"
}
],
"statistics": {
"sentences": 1,
"words": 7,
"letters": 34,
"characters": 41,
"paragraphs": 1,
"timeToRead": "00:00:02",
"fleschKincaidScore": 72,
"readabilityScore": 100,
"sentenceLengthAvg": "0.0",
"sentenceLengthText": "Sehr kurz"
}
}

Neu: KI Funktionen im API-Plus-Paket

Wenn Du zu username, apiKey und text zusätzlich ai als POST-Parameter angibst, machst Du einen KI-API-Call. Pro KI-API-Call werden maximal 5.000 Zeichen analysiert.

Mögliche Werte für den ai POST-Parameter sind:

synapi: Finde Synonyme für das Wort im POST-Parameter text
addtextapi: Ergänze den Text text sinnvoll.
summarizeapi: Fasse den Text text zusammen.
spellingapi: Verbessere Fehler im Text text.
simplifyapi: Vereinfache den Text text.
headlineapi: Finde eine Überschrift für text.
sentimentapi: Wie ist die Stimmung des Textes text?
divideapi: Teile zu lange Sätze im Text text auf.

KI-API-Call Beispiel:

Eingabe POST-Parameter (neben username und apiKey):

text: „initialisieren“
ai: „synapi“

JSON-Antwort:
{"software":{"name":"Wortliga Textanalyse API","version":"2023.03.30.0"},"aitask":"synapi","result":"starten, einleiten, aufnehmen, eröffnen, einläuten, in Gang setzen, auf den Weg bringen"}

Stand: 30.03.2023