Documentation de l'API de vérification de la grammaire et de l'orthographe

L'API de Textgears vous permet d'intégrer les dernières technologies d'analyse de texte à n'importe quel produit, qu'il s'agisse de simples applications mobiles ou de développements d'entreprise volumineux. L'API vous permet de rechercher toutes sortes d'erreurs dans un texte de manière flexible, de déterminer la lisibilité du texte, d'évaluer le vocabulaire approximatif de l'auteur, et bien plus encore.

Que peut faire l'API ?

Documents pour Postman

Vous pouvez télécharger le fichier de documentation API pour Postman ou tout autre programme de débogage HTTP. Dans Postman, vous pouvez définir une clé dans l'onglet Variables de la collection..

Download TextGears.postman.json

Où commencer

C'est simple et facile. L'API est disponible pour les demandes régulières HTTP et HTTPS. Les données de sortie sont envoyées en JSON.Toutes les demandes sont faites au api.textgears.com serveur

Pour accélérer l'accès depuis différentes parties du monde, nous avons placé des serveurs dans 3 pays : États-Unis, Estonie et Singapour. Lorsque vous soumettez une requête à api.textgears.com, nous choisissons le cluster le plus proche. Mais vous pouvez explicitement faire des demandes au cluster situé à proximitépour réduire le délai de réception d'une réponse.

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

Tous les points de terminaison de l'API sont des grappes indépendantes de serveurs. Nous garantissons une serviceabilité à 99,9 % pour chacune d'entre elles. Si cela vous semble insuffisant, vous pouvez changer de grappe lorsqu'une erreur de connexion se produit.

                                                    
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

Si vous avez implémenté une bibliothèque pour travailler avec l'API dans un autre langage ou pour un autre framework, vous n'avez qu'à nous envoyer un lien sur GitHub ou GitLab, tandis que nous le publierons également.

Langues prises en charge

TextGears analyse le texte non seulement en tenant compte de la langue du texte, mais aussi en gardant à l'esprit le dialecte. Liste complète des langues prises en charge: Anglais, français, allemand, portugais, italien, espagnol, japonais, chinois, grec

Dialectes supportés (doivent être envoyés dans le paramètre language) : en-US, en-GB, en-ZA, en-AU, en-NZ, fr-FR, de-DE, de-AT, de-CH, pt-PT, pt-BR, it-IT, es-ES, ja-JP, zh-CN, el-GR

Transfert d'autorisations et de paramètres

La demande est autorisée par le transfert de votre clé parmi d'autres paramètres de l'une des manières suivantes:

  • POST parameter key
  • GET parameter key
    ?key=YOURKEY
  • Json-request
    {
        "key": "YOURKEY",
        // Other params
    }
  • HTTP Header
    Authorization: Basic YOURKEY
    Où YOURKEY est votre clé

Codes d'erreur

En cas d'erreur, le paramètre status aura la valeur false

{
    status : false,
    error_code : 600,  // API error code
    description : "Invalid license key. Go to https://textgears.com/signup.php to get one"
}
  • 600 - Clé invalide
  • 606 - Langue non supportée
  • 607 - Nombre autorisé de requêtes dépassé
  • 500 - Erreur de service interne inconnu
  • 501 - La longueur du texte dépasse la limite de débit

API de validation de texte

Vérifier la grammaire du texte

https://api.textgears.com/grammar

Cette méthode vous permet de vérifier que le texte ne contient pas de fautes de grammaire, d'orthographe, de ponctuation et de style.

Paramètres de la requête
Paramètre Exemple Description
text Texte encodé en UTF-8. Nous recommandons d'envoyer du texte pur sans balises HTML et sans caractères UTF-8 invalides. La longueur maximale est limitée par les paramètres de votre plan de facturation.
language Code de langue. C'est un paramètre facultatif, et la valeur par défaut est en-US. Liste des codes pris en charge
whitelist Non requis. Tableau des mots et des phrases qui ne doivent pas être détectés comme des erreurs.
dictionary_id Non requis. Identifiant de dictionnaire personnalisé. Le dictionnaire est un groupe de règles personnalisées. Créer et éditer des dictionnaires.
key Votre clé API. Vous n'avez pas de clé ? Obtenez-le en un clic !.
Exemple de requête
https://api.textgears.com/grammar?key=DEMO_KEY&text=I+is+an+engeneer!&language=en-GB

Envoyer la demande Le résultat s'affiche ci-dessous

Réponse du serveur
                                            
{
    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"
            }
        ]
    }
}
                                            
                                        

Vérification de l'orthographe du texte

https://api.textgears.com/spelling

La méthode vérifie la présence de fautes de frappe dans le texte en utilisant le dictionnaire mis à jour

Paramètres de la requête
Paramètre Exemple Description
text Texte encodé en UTF-8. Nous recommandons d'envoyer du texte pur sans balises HTML et sans caractères UTF-8 invalides. La longueur maximale est limitée par les paramètres de votre plan de facturation.
language Code de langue. C'est un paramètre facultatif, et la valeur par défaut est en-US. Liste des codes pris en charge
whitelist Non requis. Tableau des mots et des phrases qui ne doivent pas être détectés comme des erreurs.
dictionary_id Non requis. Identifiant de dictionnaire personnalisé. Le dictionnaire est un groupe de règles personnalisées. Créer et éditer des dictionnaires.
key Votre clé API. Vous n'avez pas de clé ? Obtenez-le en un clic !.
Exemple de requête
https://api.textgears.com/spelling?key=DEMO_KEY&text=I+is+an+engeneer!&language=en-GB

Envoyer la demande Le résultat s'affiche ci-dessous

Réponse du serveur
                                            
{
    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-correction du texte

https://api.textgears.com/suggest

Le système de vérification corrige automatiquement les erreurs dans le texte et propose une suite à la dernière phrase.

Important !

Si une faute de frappe est trouvée, le mot est remplacé par le mot le plus proche du dictionnaire. TextGears est encore loin de la télépathie, donc s'il y a beaucoup de fautes de frappe, le sens du texte final peut changer.

Paramètres de la requête
Paramètre Exemple Description
text Texte encodé en UTF-8. Nous recommandons d'envoyer du texte pur sans balises HTML et sans caractères UTF-8 invalides. La longueur maximale est limitée par les paramètres de votre plan de facturation.
language Code de langue. C'est un paramètre facultatif, et la valeur par défaut est en-US. Liste des codes pris en charge
key Votre clé API. Vous n'avez pas de clé ? Obtenez-le en un clic !.
Exemple de requête
https://api.textgears.com/suggest?key=DEMO_KEY&text=I+is+an+engeneer!+My+na

Envoyer la demande Le résultat s'affiche ci-dessous

Réponse du serveur
                                            
{
    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"
            }
        ]
    }
}
                                            
                                        

Lisibilité du texte

https://api.textgears.com/readability

Calcul de la lisibilité du texte selon les algorithmes les plus courants et leurs adaptations pour la plupart des langues. Vous pouvez en savoir plus sur les mesures de lisibilité.en lisant notre article séparé.

Important !

Lors de la détermination des métriques du texte, la précision est directement liée à la taille du texte.Déterminer la lisibilité ou d'autres paramètres du texte pour une phrase de deux mots n'a aucun sens.Il est recommandé de vérifier les textes qui ont au moins 30 mots. Plus il y en a, mieux c'est.\N

Paramètres de la requête
Paramètre Description
text Texte encodé en UTF-8. Nous recommandons d'envoyer du texte pur sans balises HTML et sans caractères UTF-8 invalides. La longueur maximale est limitée par les paramètres de votre plan de facturation.
language Code de langue. C'est un paramètre facultatif, et la valeur par défaut est en-US. Liste des codes pris en charge
key Votre clé API. Vous n'avez pas de clé ? Obtenez-le en un clic !.
Exemple de requête
text
https://api.textgears.com/readability?key=DEMO_KEY&text=...

Envoyer la demande Le résultat s'affiche ci-dessous

Réponse du serveur
                                            
{
    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
            }
        }
    }
}
                                            
                                        

Analyse de texte

https://api.textgears.com/analyze

Analyse complète du texte. Il trouve toutes sortes d'erreurs, calcule les métriques de lisibilité, note l'orthographe sur une échelle de 100 points et évalue également l'humeur émotionnelle du texte.

Important !

Lors de la détermination des métriques du texte, la précision est directement liée à la taille du texte.Déterminer la lisibilité ou d'autres paramètres du texte pour une phrase de deux mots n'a aucun sens.Il est recommandé de vérifier les textes qui ont au moins 30 mots. Plus il y en a, mieux c'est.\N

Paramètres de la requête
Paramètre Description
text Texte encodé en UTF-8. Nous recommandons d'envoyer du texte pur sans balises HTML et sans caractères UTF-8 invalides. La longueur maximale est limitée par les paramètres de votre plan de facturation.
language Code de langue. C'est un paramètre facultatif, et la valeur par défaut est en-US. Liste des codes pris en charge
whitelist Non requis. Tableau des mots et des phrases qui ne doivent pas être détectés comme des erreurs.
dictionary_id Non requis. Identifiant de dictionnaire personnalisé. Le dictionnaire est un groupe de règles personnalisées. Créer et éditer des dictionnaires.
key Votre clé API. Vous n'avez pas de clé ? Obtenez-le en un clic !.
Exemple de requête
https://api.textgears.com/analyze?key=DEMO_KEY&text=...
Réponse du serveur
                                            
{
    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
                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,
            }
        }
    }
}
                                            
                                        

Détection de la langue

https://api.textgears.com/detect

Détermination de la langue du texte et de l'hypothèse de son dialecte.La méthode renvoie un tableau d'options probables pour chaque langue. S'il n'est pas possible d'identifier sans ambiguïté la langue, le champ language renvoie null

Paramètres de la requête
Paramètre Description
text Texte encodé en UTF-8. Nous recommandons d'envoyer du texte pur sans balises HTML et sans caractères UTF-8 invalides. La longueur maximale est limitée par les paramètres de votre plan de facturation.
key Votre clé API. Vous n'avez pas de clé ? Obtenez-le en un clic !.
Exemple de requête
text
https://api.textgears.com/detect?key=DEMO_KEY&text=...

Envoyer la demande Le résultat s'affiche ci-dessous

Réponse du serveur
                                            
{
    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,
        }
    }
}
                                            
                                        

Résumés et extraction de mots-clés

https://api.textgears.com/summarize
Paramètres de la requête
Paramètre Description
text Texte encodé en UTF-8. Nous recommandons d'envoyer du texte pur sans balises HTML et sans caractères UTF-8 invalides. La longueur maximale est limitée par les paramètres de votre plan de facturation.
language Code de langue. C'est un paramètre facultatif, et la valeur par défaut est en-US. Liste des codes pris en charge
max_sentences Paramètre optionnel. Nombre maximum de phrases dans le résumé
key Votre clé API. Vous n'avez pas de clé ? Obtenez-le en un clic !.
Exemple de requête
language
text
https://api.textgears.com/summarize?key=DEMO_KEY&language=en-GB&text=...

Envoyer la demande Le résultat s'affiche ci-dessous

Réponse du serveur
                                            
{
    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

Planifier le quota

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

Réception de données sur le quota actuel du plan. Cette méthode peut être utilisée pour savoir combien de demandes ont déjà été faites dans le cadre du plan, ou combien de demandes peuvent encore être faites pendant la période de facturation.

Paramètres de la requête
Paramètre Exemple Description
key Votre clé API. Vous n'avez pas de clé ? Obtenez-le en un clic !.
Exemple de requête
https://api.textgears.com/account/resourcequota?key=DEMO_KEY

Envoyer la demande Le résultat s'affiche ci-dessous

Réponse du serveur
                                            
{
    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)
        },
    },
}
                                            
                                        

Statistiques d'utilisation

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

Obtenir des statistiques d'utilisation de l'API pour votre compte avec une répartition par jour

Paramètres de la requête
Paramètre Exemple Description
period_start Début de la période. Paramètre facultatif..
period_end Fin de la période. Paramètre facultatif. Si la période n'est pas spécifiée, les données des 30 derniers jours sont affichées.
key Votre clé API. Vous n'avez pas de clé ? Obtenez-le en un clic !.
Exemple de requête
https://api.textgears.com/account/usage?key=DEMO_KEY

Envoyer la demande Le résultat s'affiche ci-dessous

Réponse du serveur
                                            
{
    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
        }
    ]
}
                                            
                                        

Créer et éditer des dictionnaires

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

Si vous avez besoin d'un paramètre flexible pour vérifier les erreurs dans le texte, utilisez le paramètre des exceptions personnalisées. Cela sera particulièrement utile pour les entreprises qui travaillent avec des textes contenant des mots issus d'un vocabulaire particulier. Marquez les mots ou les phrases comme étant "corrects" afin que le système cesse de les considérer comme des erreurs. Vous pouvez également l'utiliser pour permettre au système de trouver des erreurs en fonction de la liste de mots spécifiques.Les règles personnalisées peuvent être combinées et transformées en dictionnaires. Une telle approche permet aux différentes fonctions de votre produit d'utiliser un ensemble de règles différent. En même temps, chaque utilisateur de votre produit peut disposer de son propre ensemble d'exceptions

Paramètres de la requête
Paramètre Description
id Id du dictionnaire personnalisé. Oui, vous définissez l'id par vous-même. Deux comptes différents peuvent créer des dictionnaires avec les mêmes ids.Peut être un nombre, une chaîne ou même null.Le dictionnaire par défaut a id === null. Il sera rempli d'exceptions créées sans le paramètre dictionary_id.
title Titre du dictionnaire. Longueur maximale : 500 caractères.
key Votre clé API. Vous n'avez pas de clé ? Obtenez-le en un clic !.
https://api.textgears.com/custom/updatedictionary
Paramètre Description
id Id. du dictionnaire. Peut être n'importe quelle chaîne jusqu'à 64 caractères ou null.
title Titre du dictionnaire. Longueur maximale : 500 caractères.
key Votre clé API. Vous n'avez pas de clé ? Obtenez-le en un clic !.
https://api.textgears.com/custom/listdictionaries
Paramètre Description
limit Le nombre maximum d'enregistrements dans le résultat. Pas plus de 500..
offset Combien d'enregistrements seront ignorés.
key Votre clé API. Vous n'avez pas de clé ? Obtenez-le en un clic !.
https://api.textgears.com/custom/deletedictionary
Paramètre Description
id Id. du dictionnaire. Peut être n'importe quelle chaîne jusqu'à 64 caractères ou null
key Votre clé API. Vous n'avez pas de clé ? Obtenez-le en un clic !.

Ajouter une exception

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

Si vous vérifiez des textes au vocabulaire très spécifique qui sont marqués comme des erreurs dans notre système, vous pouvez ajouter des mots ou des phrases aux exceptions. Après cela, ils ne seront plus considérés comme des erreurs.

Paramètres de la requête
Paramètre Description
text Un mot ou un texte à marquer d'une autre manière personnalisée. La longueur maximale est de 500 caractères.
type Type d'exception. Valeurs possibles : 1 &ndash ; text EST une erreur, 2 &ndash ; text n'est PAS une erreur.
lang Code de langue. L'exception ne sera appliquée qu'au texte dans cette langue.
description Non requis. Custom exception description.
dictionary_id Paramètre non requis. Dictionnaire personnalisé (un groupe d'exceptions) id. Chaîne, la longueur peut aller jusqu'à 64 caractères ou NULL.Vous pouvez définir le paramètre dictionary_id tout en envoyant la requête analyze ou check pour choisir un dictionnaire à appliquer.
key Votre clé API. Vous n'avez pas de clé ? Obtenez-le en un clic !.
Exemple de requête
https://api.textgears.com/custom/addexception?text=foobaring&type=2&lang=en-US&key=DEMO_KEY
Réponse du serveur
                                            
{
    status : true,
    response : {
        id: 20, // New exception id
        text: "foobaring",
        type: 1,
        lang: "en-US",
        creation_time: "2021-06-20T12:57:58+0000",
        update_time: null,
        description: null,
    },
}
                                            
                                        

Liste des exceptions

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

Liste des mots d'exclusion précédemment ajoutés

Paramètres de la requête
Paramètre Description
limit Le nombre maximum d'enregistrements dans le résultat. Pas plus de 500..
offset Combien d'enregistrements classés par texte sont ignorés dans la sortie. Utilisé pour la sortie paginée..
dictionary_id Non requis. Id du dictionnaire (groupe d'exceptions). Pour obtenir toutes les exceptions du dictionnaire par défaut, vous pouvez utiliser la valeur null.
text Non requis. Filtre de texte.
type Non requis. Filtre de type d'exception.
lang Non requis. Filtre de langue.
key Votre clé API. Vous n'avez pas de clé ? Obtenez-le en un clic !.
Exemple de requête
https://api.textgears.com/custom/addexception?text=foobaring&key=DEMO_KEY
Réponse du serveur
                                            
{
    status : true,
    response : {
        exceptions : [
            {
                id: 20,
                text: "foobaring",
                type: 1,
                lang: "en-US",
                creation_time: "2021-06-20T12:57:58+0000",
                update_time: null,
                description: null,
            },
        ],
    },
}
                                            
                                        

Retirer l'exception

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

Supprimez le mot d'exception pour vérification. Si vous essayez de supprimer un mot précédemment supprimé, aucune erreur ne se produit.

Paramètres de la requête
Paramètre Description
id ID d'exception à supprimer.
dictionary_id Id. du dictionnaire. Peut être n'importe quelle chaîne jusqu'à 64 caractères ou null.
key Votre clé API. Vous n'avez pas de clé ? Obtenez-le en un clic !.
Exemple de requête
https://api.textgears.com/custom/deleteexception?id=20&key=DEMO_KEY
Réponse du serveur
                                            
{
    status : true,
    response : {}
}