How to use
Textvalidierung API
Admin API
Sonstiges

API-Dokumentation zur Grammatik- und Rechtschreibprüfung

Mit der TextGears API können Sie die neuesten Technologien zur Textanalyse in praktisch jedes Produkt integrieren. Von einfachen mobilen Apps bis hin zu umfangreichen Unternehmensentwicklungen.Die API ermöglicht es Ihnen, Texte flexibel auf alle Arten von Fehlern zu prüfen, die Lesbarkeit des Textes zu bestimmen, das ungefähre Vokabular des Autors auszuwerten und vieles mehr.

Suchen Sie ein Plugin für eine Website?

Sie können Ihrer Website ganz einfach eine Textprüfung hinzufügen. Weitere Informationen zum Plugin und Beispielcode finden Sie auf der Dokumentationsseite.

Was kann die API tun?

Docs für Postman

Sie können die API-Dokumentationsdatei für Postman oder jedes andere HTTP-Debugging-Programm herunterladen. In Postman können Sie auf der Registerkarte Sammelvariablen einen Schlüssel setzen..

Download TextGears.postman.json

Wo soll ich anfangen

Es ist einfach und leicht. Die API ist für reguläre HTTP- und HTTPS-Anfragen verfügbar.Die Ausgabedaten werden in JSON gesendet. Alle Anfragen erfolgen an den api.textgears.com-Server

Um den Zugriff aus verschiedenen Teilen der Welt zu beschleunigen, haben wir Server in 3 Ländern aufgestellt: USA, Estland und Singapur. Wenn Sie eine Anfrage an api.textgears.com stellen, wählen wir den nächstgelegenen Cluster. Sie können jedoch explizit Anfragen an den Cluster stellen, der sich in der Nähe befindet, um die Verzögerung beim Erhalt einer Antwort zu verringern.

https://eu.api.textgears.com – Europe
https://us.api.textgears.com – America
https://sg.api.textgears.com – Asia

Alle API-Endpunkte sind unabhängige Cluster von Servern. Wir garantieren eine 99,9%ige Verfügbarkeit für jeden von ihnen. Wenn Ihnen das nicht ausreichend erscheint, können Sie den Cluster wechseln, wenn ein Verbindungsfehler auftritt. 

                                                    
import textgears from 'textgears-api';

const textgearsApi = textgears('YOUR_KEY', {language: 'en-US'});
textgearsApi.checkGrammar('I is a engineer')
    .then((data) => {
        for (const error of data.errors) {
            console.log('Error: %s. Suggestions: %s', error.bad, error.better.join(', '));
        }
    })
    .catch((err) => {});

Javascript library

Wenn Sie eine Bibliothek für die Arbeit mit API in einer anderen Sprache oder für ein anderes Framework implementiert haben,schicken Sie uns einfach einen Linkauf GitHub oder GitLab, wir werden ihn dann ebenfalls veröffentlichen.

Unterstützte Sprachen

TextGears analysiert Text nicht nur unter Berücksichtigung der Sprache des Textes, sondern auch unter Berücksichtigung des Dialekts. Vollständige Liste der unterstützten Sprachen: Englisch, Französisch, Deutsch, Portugiesisch, Italienisch, Spanisch, Russisch, Arabisch, Japanisch, Chinesisch, Griechisch

Unterstützte Dialekte (müssen im Parameter language übergeben werden): en-US, en-GB, en-ZA, en-AU, en-NZ, fr-FR, de-DE, de-AT, de-CH, pt-PT, pt-BR, it-IT, ar-AR, ru-RU, es-ES, ja-JP, zh-CN, el-GR

Berechtigung und Parameterübergabe

Die Anfrage wird durch Übergabe des Schlüssels neben anderen Parametern auf eine der folgenden Arten autorisiert:

  • POST parameter key
  • GET parameter key 
    ?key=YOURKEY
  • Json-request 
    {
    "key": "YOURKEY",
    // Other params
}
  • HTTP Header 
    Authorization: Basic YOURKEY
    Wobei YOURKEY Ihr Schlüssel ist.

Fehlercodes

Im Falle eines Fehlers wird der Parameter status den Wert false haben 

{
    status : false,
    error_code : 600,  // API error code
    description : "Invalid license key. Go to https://textgears.com/signup.php to get one"
}
  • 600 - Ungültiger Schlüssel
  • 606 - Nicht unterstützte Sprache
  • 607 - Erlaubte Anzahl von Anfragen überschritten
  • 500 - Unbekannter interner Dienstfehler
  • 501 - Textlänge überschreitet Ratengrenze

Textvalidierung API

Überprüfung der Grammatik des Textes

https://api.textgears.com/grammar

Mit dieser Methode können Sie den Text auf Grammatik-, Rechtschreib-, Zeichensetzungs- und Stilfehler überprüfen.

Anfrageparameter
Parameter Beispiel Beschreibung
text UTF-8 kodierter Text. Wir empfehlen, reinen Text ohne HTML-Tags und ungültige UTF-8-Zeichen zu senden. Die maximale Länge ist durch die Parameter Ihres Abrechnungstarifs begrenzt.
language Sprachcode. Es ist ein optionaler Parameter, und der Standardwert ist en-US. Liste der unterstützten Codes
whitelist Nicht erforderlich. Array von Wörtern und Phrasen, die nicht als Fehler erkannt werden dürfen.
dictionary_id Nicht erforderlich. Benutzerdefiniertes Wörterbuch id. Dictionary is a group of custom rules. Wörterbücher erstellen und bearbeiten.
ai true, false, 1, 0. Verwenden Sie TextGears AI, um die Qualität der Textanalyse zu verbessern.
key Ihr API-Schlüssel. Haben Sie keinen Schlüssel? Holen Sie es sich mit einem Klick!.
Beispiel anfordern
https://api.textgears.com/grammar?key=DEMO_KEY&text=I+is+an+engeneer!&language=en-GB

Anfrage senden Das Ergebnis wird unten angezeigt

Server-Antwort
                                            
{
    status : true, // false in case of checking error
    response : {
        errors : [  // array of errors info
            0 : {
                id : "e492411846",  // unique error id
                offset : 2,  // error text offset
                length : 2,  // error text length
                bad : "is",  // error text
                better : [  // array of suggestions
                    0 : "am"
                ],
                type : "grammar"
            },
            1 : {
                id : "e627659964",  // unique error id
                offset : 8,  // error text offset
                length : 8,  // error text length
                bad : "engeneer",  // error text
                better : [  // array of suggestions
                    0 : "engineer",
                    1 : "engender"
                ],
                type : "spelling"
            }
        ]
    }
}

Überprüfung der Rechtschreibung des Textes

https://api.textgears.com/spelling

Die Methode prüft den Text auf Tippfehler unter Verwendung des aktualisierten Wörterbuchs

Anfrageparameter
Parameter Beispiel Beschreibung
text UTF-8 kodierter Text. Wir empfehlen, reinen Text ohne HTML-Tags und ungültige UTF-8-Zeichen zu senden. Die maximale Länge ist durch die Parameter Ihres Abrechnungstarifs begrenzt.
language Sprachcode. Es ist ein optionaler Parameter, und der Standardwert ist en-US. Liste der unterstützten Codes
whitelist Nicht erforderlich. Array von Wörtern und Phrasen, die nicht als Fehler erkannt werden dürfen.
dictionary_id Nicht erforderlich. Benutzerdefiniertes Wörterbuch id. Dictionary is a group of custom rules. Wörterbücher erstellen und bearbeiten.
ai true, false, 1, 0. Verwenden Sie TextGears AI, um die Qualität der Textanalyse zu verbessern.
key Ihr API-Schlüssel. Haben Sie keinen Schlüssel? Holen Sie es sich mit einem Klick!.
Beispiel anfordern
https://api.textgears.com/spelling?key=DEMO_KEY&text=I+is+an+engeneer!&language=en-GB

Anfrage senden Das Ergebnis wird unten angezeigt

Server-Antwort
                                            
{
    status : true, // false in case of checking error
    response : {
        errors : [  // array of errors info
            0 : {
                id : "e627659964",  // unique error id
                offset : 8,  // error text offset
                length : 8,  // error text length
                bad : "engeneer",  // error text
                description: "Error description",
                better : [  // array of suggestions
                    0 : "engineer",
                    1 : "engender"
                ],
                type : "spelling"
            }
        ]
    }
}

Auto-Korrektur von Text

https://api.textgears.com/correct

Es gibt zwei Methoden für die automatische Textkorrektur. Die „correct“ Methode ist deutlich präziser, gilt aber für KI-Anfragen.

Wichtig!

Im Moment funktioniert die Methode nur für die englische Sprache.

Anfrageparameter
Parameter Beispiel Beschreibung
text UTF-8 kodierter Text. Wir empfehlen, reinen Text ohne HTML-Tags und ungültige UTF-8-Zeichen zu senden. Die maximale Länge ist durch die Parameter Ihres Abrechnungstarifs begrenzt.
language Sprachcode. Es ist ein optionaler Parameter, und der Standardwert ist en-US. Liste der unterstützten Codes
key Ihr API-Schlüssel. Haben Sie keinen Schlüssel? Holen Sie es sich mit einem Klick!.
Beispiel anfordern
https://api.textgears.com/correct?text=What+are+you+name%3F&language=en-GB&key=DEMO_KEY

Anfrage senden Das Ergebnis wird unten angezeigt

Server-Antwort
                                            
{
    status : true,  // false in case of checking error
    response : {
        corrected : "What is your name?"  // corrected text
    }
}
                                            
                                        
https://api.textgears.com/suggest

Das Prüfverfahren korrigiert automatisch Fehler im Text und schlägt eine Fortsetzung des letzten Satzes vor.

Wichtig!

Wenn ein Tippfehler gefunden wird, wird das Wort durch das nächstliegende Wort aus dem Wörterbuch ersetzt. Wenn es mehrere Wörter gibt, die dem gefundenen ähnlich sehen, wird das häufigste Wort in der modernen Sprache gewählt. TextGears ist noch weit von Telepathie entfernt, so dass sich bei vielen Tippfehlern die Bedeutung des endgültigen Textes ändern kann.

Anfrageparameter
Parameter Beispiel Beschreibung
text UTF-8 kodierter Text. Wir empfehlen, reinen Text ohne HTML-Tags und ungültige UTF-8-Zeichen zu senden. Die maximale Länge ist durch die Parameter Ihres Abrechnungstarifs begrenzt.
language Sprachcode. Es ist ein optionaler Parameter, und der Standardwert ist en-US. Liste der unterstützten Codes
key Ihr API-Schlüssel. Haben Sie keinen Schlüssel? Holen Sie es sich mit einem Klick!.
Beispiel anfordern
https://api.textgears.com/suggest?key=DEMO_KEY&text=I+is+an+engeneer!+My+na

Anfrage senden Das Ergebnis wird unten angezeigt

Server-Antwort
                                            
{
    status : true,  // false in case of checking error
    response : {
        corrected : "My name is Seth. My family",  // corrected text
        suggestions : [  // array of suggested text endings
            0 : {
                text : "My name is Seth. My family wishes",
                next_word : "wishes"
            },
            1 : {
                text : "My name is Seth. My family traditions",
                next_word : "traditions"
            },
            2 : {
                text : "My name is Seth. My family together",
                next_word : "together"
            },
            3 : {
                text : "My name is Seth. My family support",
                next_word : "support"
            },
            4 : {
                text : "My name is Seth. My family respectfully",
                next_word : "respectfully"
            }
        ]
    }
}

Lesbarkeit des Textes

https://api.textgears.com/readability

Berechnung der Lesbarkeit des Textes nach den gängigsten Algorithmen und deren Anpassungen für die meisten Sprachen. Sie können mehr über Lesbarkeitsmetriken erfahren,in unserem separaten Artikel.

Wichtig!

Bei der Bestimmung von Textmetriken steht die Genauigkeit in direktem Zusammenhang mit der Größe des Textes.Die Bestimmung der Lesbarkeit oder anderer Parameter des Textes für einen Zwei-Wort-Satz ist sinnlos.Es wird empfohlen, Texte zu prüfen, die mindestens 30 Wörter haben. Je mehr, desto besser.

Anfrageparameter
Parameter Beschreibung
text UTF-8 kodierter Text. Wir empfehlen, reinen Text ohne HTML-Tags und ungültige UTF-8-Zeichen zu senden. Die maximale Länge ist durch die Parameter Ihres Abrechnungstarifs begrenzt.
language Sprachcode. Es ist ein optionaler Parameter, und der Standardwert ist en-US. Liste der unterstützten Codes
key Ihr API-Schlüssel. Haben Sie keinen Schlüssel? Holen Sie es sich mit einem Klick!.
Beispiel anfordern
text 
https://api.textgears.com/readability?key=DEMO_KEY&text=...

Anfrage senden Das Ergebnis wird unten angezeigt

Server-Antwort
                                            
{
    status : true,  // false in case of checking error
    response : {
        stats : {
            fleschKincaid : { // Flesch–Kincaid index (https://en.wikipedia.org/wiki/Flesch–Kincaid_readability_tests)
                readingEase : 53.4, // Index value
                grade : "10th to 12th grade", // Flesch–Kincaid grade
                interpretation : "Fairly difficult to read" // index value interpretation
            },
            gunningFog : 12.2, // https://en.wikipedia.org/wiki/Gunning_fog_index
            colemanLiau : 12, // https://en.wikipedia.org/wiki/Coleman–Liau_index
            SMOG : 12, // https://en.wikipedia.org/wiki/SMOG
            vocabularySize : {
                active : null, // How many words author uses every day
                passive : null // How many words author knows
            },
            emotion : { // text emotion classifier
                positive : 0.79,
                negative : 0.21
            },
            counters : {
                length : 1128,
                clearLength : 936,
                words : 187,
                sentences : 10
            }
        }
    }
}

Textanalyse

https://api.textgears.com/analyze

Umfassende Textanalyse. Sie findet alle Arten von Fehlern, berechnet Lesbarkeitskennzahlen, bewertet die Rechtschreibung auf einer 100-Punkte-Skala und bewertet auch die emotionale Stimmung des Textes.

Wichtig!

Bei der Bestimmung von Textmetriken steht die Genauigkeit in direktem Zusammenhang mit der Größe des Textes.Die Bestimmung der Lesbarkeit oder anderer Parameter des Textes für einen Zwei-Wort-Satz ist sinnlos.Es wird empfohlen, Texte zu prüfen, die mindestens 30 Wörter haben. Je mehr, desto besser.

Anfrageparameter
Parameter Beschreibung
text UTF-8 kodierter Text. Wir empfehlen, reinen Text ohne HTML-Tags und ungültige UTF-8-Zeichen zu senden. Die maximale Länge ist durch die Parameter Ihres Abrechnungstarifs begrenzt.
language Sprachcode. Es ist ein optionaler Parameter, und der Standardwert ist en-US. Liste der unterstützten Codes
whitelist Nicht erforderlich. Array von Wörtern und Phrasen, die nicht als Fehler erkannt werden dürfen.
dictionary_id Nicht erforderlich. Benutzerdefiniertes Wörterbuch id. Dictionary is a group of custom rules. Wörterbücher erstellen und bearbeiten.
ai true, false, 1, 0. Verwenden Sie TextGears AI, um die Qualität der Textanalyse zu verbessern.
key Ihr API-Schlüssel. Haben Sie keinen Schlüssel? Holen Sie es sich mit einem Klick!.
Beispiel anfordern
https://api.textgears.com/analyze?key=DEMO_KEY&text=...
Server-Antwort
                                            
{
    status : true, // false in case of checking error
    response : {
        grammar: {
            errors : [  // array of errors info
                0 : {
                    id : "e492411846",  // unique error id
                    offset : 2,  // error text offset
                    length : 2,  // error text length
                    description: "Error description",
                    bad : "is",  // error text
                    better : [  // array of suggestions
                        0 : "am"
                    ],
                    type : "grammar"
                },
                1 : {
                    id : "e627659964",  // unique error id
                    offset : 8,  // error text offset
                    length : 8,  // error text length
                    bad : "engeneer",  // error text
                    description: "Error description",
                    better : [  // array of suggestions
                        0 : "engineer",
                        1 : "engender"
                    ],
                    type : "spelling"
                }
            ],
        },
        stats: {
             fleschKincaid : { // Flesch–Kincaid index (https://en.wikipedia.org/wiki/Flesch–Kincaid_readability_tests)
                readingEase: 63.3, // Index value
                grade : "8th or 9th grade", // Flesch–Kincaid grade
                interpretation: "Plain English. Easily understood by 13- to 15-year-old students", // index value interpretation
             }
            gunningFog : 9.4, // https://en.wikipedia.org/wiki/Gunning_fog_index
            colemanLiau : 12, // https://en.wikipedia.org/wiki/Coleman–Liau_index
            SMOG : 6.5, // https://en.wikipedia.org/wiki/SMOG
            vocabularySize : {
                active: 5000, // How many words author uses every day
                passinve: 60000, // How many words author knows
            }
            emotion: { // text emotion classifier
                positive: 0.79, // probability
                negative: 0.21,
            }
        }
    }
}

Spracherkennung

https://api.textgears.com/detect

Bestimmung der Sprache des Textes und die Annahme seines Dialekts.Die Methode gibt ein Array mit wahrscheinlichen Optionen für jede Sprache zurück. Wenn es nicht möglich ist, die Sprache eindeutig zu identifizieren, gibt das Feld language null zurück.

Anfrageparameter
Parameter Beschreibung
text UTF-8 kodierter Text. Wir empfehlen, reinen Text ohne HTML-Tags und ungültige UTF-8-Zeichen zu senden. Die maximale Länge ist durch die Parameter Ihres Abrechnungstarifs begrenzt.
key Ihr API-Schlüssel. Haben Sie keinen Schlüssel? Holen Sie es sich mit einem Klick!.
Beispiel anfordern
text 
https://api.textgears.com/detect?key=DEMO_KEY&text=...

Anfrage senden Das Ergebnis wird unten angezeigt

Server-Antwort
                                            
{
    status : true, // false in case of checking error
    response : {
        language : "en", // null if language was not detected
        dialect : "en-GB", // language dialect suggestion
        probabilities : { // descending
            "en" : 0.95,
            "fr" : 0.61,
            "ge" : 0.60,
            "fi" : 0.51,
        }
    }
}

Zusammenfassung und Schlagwortextraktion

https://api.textgears.com/summarize
Anfrageparameter
Parameter Beschreibung
text UTF-8 kodierter Text. Wir empfehlen, reinen Text ohne HTML-Tags und ungültige UTF-8-Zeichen zu senden. Die maximale Länge ist durch die Parameter Ihres Abrechnungstarifs begrenzt.
language Sprachcode. Es ist ein optionaler Parameter, und der Standardwert ist en-US. Liste der unterstützten Codes
max_sentences Optionaler Parameter. Maximale Anzahl von Sätzen in der Zusammenfassung
key Ihr API-Schlüssel. Haben Sie keinen Schlüssel? Holen Sie es sich mit einem Klick!.
Beispiel anfordern
language
text 
https://api.textgears.com/summarize?key=DEMO_KEY&language=en-GB&text=...

Anfrage senden Das Ergebnis wird unten angezeigt

Server-Antwort
                                            
{
    status : true,  // false in case of checking error
    response : {
        keywords : [
            0 : "text",
            1 : "readability",
            2 : "english",
            3 : "printing",
            4 : "fewer",
            5 : "words",
            6 : "terms",
            7 : "higher",
            8 : "features",
            9 : "indexes"
        ],
        highlight : [ // Most important paragraph, starting with main sentence
            0 : "The two main factors of readability are the printing and linguistic features of the text.",
            1 : "In other words, pages containing simple and clear text get higher positions in the search results."
        ],
        summary : [ // Text summary sentences
            0 : "The two main factors of readability are the printing and linguistic features of the text.",
            1 : "The Flesch Kinkaid Score is the most popular way to measure the readability of English text.",
            2 : "It works on the principle of “the fewer words in the text, and the fewer syllables in them, the easier it is to perceive” and is most often used for checking essays in schools and universities."
        ]
    }
}

Admin API

Plan-Kontingent

https://api.textgears.com/account/resourcequota

Empfangen von Daten über die aktuelle Planquote. Damit lässt sich nachvollziehen, wie viele Anfragen innerhalb des Plans bereits gestellt wurden bzw. wie viele Anfragen innerhalb des Abrechnungszeitraums noch gestellt werden können.

Anfrageparameter
Parameter Beispiel Beschreibung
key Ihr API-Schlüssel. Haben Sie keinen Schlüssel? Holen Sie es sich mit einem Klick!.
Beispiel anfordern
https://api.textgears.com/account/resourcequota?key=DEMO_KEY

Anfrage senden Das Ergebnis wird unten angezeigt

Server-Antwort
                                            
{
    status : true,
    response : {
        api : { // Resource type, "api" if you use TextGears API
            type : "api", // Resource type
            total : 1000000, // Total resource quota size
            used : 123000, // How many requests was made using this quota
            period_start: "2018-10-20T00:00:00+0000", // Quota paid period start (ISO8601 format)
            period_end: "2019-10-20T00:00:00+0000", // End of the quota paid period (ISO8601 format)
        },
    },
}

Verwendungsstatistik

https://api.textgears.com/account/usage

Abrufen von Statistiken der API-Nutzung für Ihr Konto mit einer Aufschlüsselung nach Tagen

Anfrageparameter
Parameter Beispiel Beschreibung
period_start Beginn der Periode. Optionaler Parameter..
period_end Ende der Periode. Optionaler Parameter. Wenn der Zeitraum nicht angegeben wird, werden die Daten der letzten 30 Tage angezeigt..
key Ihr API-Schlüssel. Haben Sie keinen Schlüssel? Holen Sie es sich mit einem Klick!.
Beispiel anfordern
https://api.textgears.com/account/usage?key=DEMO_KEY

Anfrage senden Das Ergebnis wird unten angezeigt

Server-Antwort
                                            
{
    status : true,  // false in case of checking error
    response : [
        0 : {
            date : "2020-04-20",
            request_count : 11875
        },
        1 : {
            date : "2020-04-21",
            request_count : 10588
        }
    ]
}

Wörterbücher erstellen und bearbeiten

https://api.textgears.com/custom/createdictionary

Wenn Sie eine flexible Einstellung für die Prüfung von Texten auf Fehler benötigen, verwenden Sie die Einstellung für benutzerdefinierte Ausnahmen. Dies ist besonders nützlich, wenn Sie mit Texten arbeiten, die viele Wörter aus einem speziellen Vokabular enthalten. Markieren Sie Wörter oder Phrasen als "korrekt", damit das System sie nicht mehr als Fehler betrachtet. Sie können es auch verwenden, um dem System zu erlauben, Fehler entsprechend der Liste bestimmter Wörter zu finden.Benutzerdefinierte Regeln können kombiniert und in Wörterbücher umgewandelt werden. Ein solcher Ansatz ermöglicht es, dass die verschiedenen Funktionen Ihres Produkts einen unterschiedlichen Satz von Regeln verwenden. Gleichzeitig kann jeder Benutzer Ihres Produkts seinen eigenen Satz von Ausnahmen haben.

Anfrageparameter
Parameter Beschreibung
id Id des benutzerdefinierten Wörterbuchs. Ja, Sie legen die Id selbst fest. Zwei verschiedene Konten können Wörterbücher mit den gleichen Ids erstellen.kann eine Zahl, eine Zeichenkette oder sogar null sein.Standardwörterbuch hat id === null. Es wird mit Ausnahmen gefüllt, die ohne dictionary_id-Parameter erstellt wurden..
title Wörterbuch-Titel. Max length: 500 chars.
key Ihr API-Schlüssel. Haben Sie keinen Schlüssel? Holen Sie es sich mit einem Klick!. 
https://api.textgears.com/custom/updatedictionary
Parameter Beschreibung
id Dictionary Id. Kann eine beliebige Zeichenkette mit bis zu 64 Zeichen oder null sein.
title Wörterbuch-Titel. Max length: 500 chars.
key Ihr API-Schlüssel. Haben Sie keinen Schlüssel? Holen Sie es sich mit einem Klick!. 
https://api.textgears.com/custom/listdictionaries
Parameter Beschreibung
limit Die maximale Anzahl von Datensätzen im Ergebnis. Nicht mehr als 500..
offset Wie viele Datensätze werden ignoriert.
key Ihr API-Schlüssel. Haben Sie keinen Schlüssel? Holen Sie es sich mit einem Klick!. 
https://api.textgears.com/custom/deletedictionary
Parameter Beschreibung
id Dictionary Id. Kann eine beliebige Zeichenkette mit bis zu 64 Zeichen oder null sein
key Ihr API-Schlüssel. Haben Sie keinen Schlüssel? Holen Sie es sich mit einem Klick!.

Eine Ausnahme hinzufügen

https://api.textgears.com/custom/addexception

Wenn Sie Texte mit sehr spezifischem Vokabular prüfen, die in unserem System als Fehler markiert sind, können Sie Wörter oder Phrasen zu Ausnahmen hinzufügen. Danach werden sie nicht mehr als Fehler betrachtet.

Anfrageparameter
Parameter Beschreibung
text Ein Wort oder ein Text, der auf eine andere benutzerdefinierte Weise markiert werden soll. Maximale Länge ist 500 Zeichen.
type Ausnahmetyp. Mögliche Werte: 2 – text IST ein Fehler, 1 – text ist KEIN Fehler.
lang Sprachcode. Ausnahme wird nur auf Text in dieser Sprache angewendet. Setzen Sie en für alle englischen Dialekte, de für alle deutschen Dialekte, pt für alle portugiesischen Dialekte usw.
description Nicht erforderlich. Benutzerdefinierte Ausnahmebeschreibung.
dictionary_id Nicht benötigter Parameter. Benutzerdefiniertes Wörterbuch (eine Gruppe von Ausnahmen) id. String, Länge bis zu 64 Zeichen oder NULL. Sie können den Parameter dictionary_id beim Senden der analyze- oder check-Anfrage setzen, um ein anzuwendendes Wörterbuch auszuwählen..
suggestions Nicht erforderlich. Vorschläge zur Textkorrektur. String-Array oder eine Zeichenfolge von durch Kommas getrennten Werten. Max. Anzahl: 16. Parameter wird ignoriert, wenn type=2.
key Ihr API-Schlüssel. Haben Sie keinen Schlüssel? Holen Sie es sich mit einem Klick!.
Beispiel anfordern
https://api.textgears.com/custom/addexception?text=foobaring&type=2&lang=en-US&key=DEMO_KEY
Server-Antwort
                                            
{
    status : true,
    response : {
        id: 20, // New exception id
        text: "foobaring",
        type: 1,
        lang: "en-US",
        creation_time: "2024-12-22T12:59:08+0000",
        suggestions: [],
        update_time: null,
        description: null,
    },
}

Liste der Ausnahmen

https://api.textgears.com/custom/listexceptions

Zuvor hinzugefügte Ausschlusswörter auflisten

Anfrageparameter
Parameter Beschreibung
limit Die maximale Anzahl von Datensätzen im Ergebnis. Nicht mehr als 500..
offset Wie viele Datensätze nach Text geordnet in der Ausgabe übersprungen werden. Wird bei seitenweiser Ausgabe verwendet..
dictionary_id Nicht erforderlich. Wörterbuch (Ausnahmegruppe) id. Um alle Ausnahmen des Standard-Wörterbuchs zu erhalten, können Sie den Wert null verwenden.
text Nicht erforderlich. Textfilter.
type Nicht erforderlich. Ausnahmetyp-Filter.
lang Nicht erforderlich. Sprachfilter.
key Ihr API-Schlüssel. Haben Sie keinen Schlüssel? Holen Sie es sich mit einem Klick!.
Beispiel anfordern
https://api.textgears.com/custom/addexception?text=foobaring&key=DEMO_KEY
Server-Antwort
                                            
{
    status : true,
    response : {
        exceptions : [
            {
                id: 20,
                text: "foobaring",
                type: 1,
                lang: "en-US",
                creation_time: "2024-12-22T12:59:08+0000",
                update_time: null,
                description: null,
            },
        ],
    },
}

Ausnahme entfernen

https://api.textgears.com/custom/deleteexception

Entfernen Sie das Ausnahmewort zur Überprüfung. Wenn Sie versuchen, ein bereits gelöschtes Wort zu löschen, tritt kein Fehler auf.

Anfrageparameter
Parameter Beschreibung
id Ausnahme-ID zum Entfernen..
dictionary_id Dictionary Id. Kann eine beliebige Zeichenkette mit bis zu 64 Zeichen oder null sein.
key Ihr API-Schlüssel. Haben Sie keinen Schlüssel? Holen Sie es sich mit einem Klick!.
Beispiel anfordern
https://api.textgears.com/custom/deleteexception?id=20&key=DEMO_KEY
Server-Antwort
                                            
{
    status : true,
    response : {}
}