Documentazione API per il controllo ortografico e grammaticale

Textgears API permette di integrare le ultime tecnologie per l'analisi del testo virtualmente a qualsiasi prodotto. Da semplici applicazioni mobili a grandi sviluppi aziendali. L'API permette di controllare il testo per tutti i tipi di errori in modo flessibile, determinare la leggibilità del testo, valutare il vocabolario approssimativo dell'autore e molto altro.

Cosa può fare l'API?

Docs per Postman

Puoi scaricare il file di documentazione API per Postman o qualsiasi altro programma di debug HTTP. In Postman puoi impostare una chiave nella scheda Variabili di raccolta..

Download TextGears.postman.json

Da dove cominciare

È semplice e facile. L'API è disponibile per le normali richieste HTTP e HTTPS. I dati in uscita sono inviati in JSON. Tutte le richieste sono fatte al server api.textgears.com.

Per velocizzare l'accesso da diverse parti del mondo, abbiamo posizionato i server in 3 paesi: USA, Estonia e Singapore. Quando invii una richiesta a api.textgears.com sceglieremo il server più vicino. Ma è possibile fare esplicitamente richieste al server situato nelle vicinanze per ridurre il ritardo nel ricevere una risposta.

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

Tutti gli endpoint API sono server indipendenti. Garantiamo un servizio del 99,9% per ognuno di essi. Se questo ti sembra insufficiente, puoi cambiare il server quando si verifica un errore di connessione

                                                    
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

Se avete implementato una library per lavorare con le API in un'altra lingua o per un altro framework, mandateci un link su GitHub o GitLab, e noi lo pubblicheremo.

Lingue supportate

TextGears analizza il testo non solo tenendo conto della lingua del testo, ma anche del dialetto. Elenco completo delle lingue supportate: Inglese, francese, tedesco, portoghese, italiano, spagnolo, giapponese, cinese, greco

I dialetti supportati (devono essere inseriti nel parametro 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

Autorizzazione e trasferimento dei parametri

La richiesta è autorizzata trasferendo la tua keyamong in altri parametri in uno dei seguenti modi:

  • POST parameter key
  • GET parameter key
    ?key=YOURKEY
  • Json-request
    {
        "key": "YOURKEY",
        // Other params
    }
  • HTTP Header
    Authorization: Basic YOURKEY
    Dove YOURKEY è la tua chiave.

Codici di errore

In caso di errore, il parametro status avrà il valore false.

{
    status : false,
    error_code : 600,  // API error code
    description : "Invalid license key. Go to https://textgears.com/signup.php to get one"
}
  • 600 - Chiave non valida
  • 606 - Lingua non supportata
  • 607 - Numero consentito di richieste superato
  • 500 - Errore di servizio interno sconosciuto
  • 501 - La lunghezza del testo supera il limite di velocità

API di convalida del testo

Controllo della grammatica del testo

https://api.textgears.com/grammar

Il metodo permette di controllare il testo per errori grammaticali, ortografici, di punteggiatura e stilistici.

Parametri della richiesta
Parametro Esempio Descrizione
text Testo codificato UTF-8. Raccomandiamo di inviare testo puro senza tag HTML e caratteri UTF-8 non validi. La lunghezza massima è limitata dai parametri del tuo piano di fatturazione.
language Codice della lingua. È un parametro opzionale e il valore predefinito è en-US. Elenco dei codici supportati
whitelist Non richiesto. Array di parole e frasi che non devono essere rilevate come errori.
dictionary_id Non richiesto. Dizionario personalizzato id. Il dizionario è un gruppo di regole personalizzate. Creazione e modifica di dizionari.
key La tua chiave API. Non hai una chiave? Ottenetela in un clic!.
Esempio di richiesta
https://api.textgears.com/grammar?key=DEMO_KEY&text=I+is+an+engeneer!&language=en-GB

Invia la richiesta Il risultato sarà mostrato qui sotto

Risposta del server
                                            
{
    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"
            }
        ]
    }
}
                                            
                                        

Controllo dell'ortografia del testo

https://api.textgears.com/spelling

Il sistema controlla il testo per gli errori di battitura utilizzando il dizionario aggiornato

Parametri della richiesta
Parametro Esempio Descrizione
text Testo codificato UTF-8. Raccomandiamo di inviare testo puro senza tag HTML e caratteri UTF-8 non validi. La lunghezza massima è limitata dai parametri del tuo piano di fatturazione.
language Codice della lingua. È un parametro opzionale e il valore predefinito è en-US. Elenco dei codici supportati
whitelist Non richiesto. Array di parole e frasi che non devono essere rilevate come errori.
dictionary_id Non richiesto. Dizionario personalizzato id. Il dizionario è un gruppo di regole personalizzate. Creazione e modifica di dizionari.
key La tua chiave API. Non hai una chiave? Ottenetela in un clic!.
Esempio di richiesta
https://api.textgears.com/spelling?key=DEMO_KEY&text=I+is+an+engeneer!&language=en-GB

Invia la richiesta Il risultato sarà mostrato qui sotto

Risposta del server
                                            
{
    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"
            }
        ]
    }
}
                                            
                                        

Correzione automatica del testo

https://api.textgears.com/suggest

Il sistema di verifica corregge automaticamente gli errori nel testo e suggerisce una continuazione dell'ultima frase.

Importante!

Se viene trovato un errore di battitura, la parola viene sostituita con quella più vicina dal dizionario. Se ci sono più parole che sembrano simili a quella rilevata, allora viene scelta la parola più comune nel linguaggio moderno. TextGears è ancora lontano dalla telepatia, quindi se ci sono molti refusi il significato del testo finale può cambiare.

Parametri della richiesta
Parametro Esempio Descrizione
text Testo codificato UTF-8. Raccomandiamo di inviare testo puro senza tag HTML e caratteri UTF-8 non validi. La lunghezza massima è limitata dai parametri del tuo piano di fatturazione.
language Codice della lingua. È un parametro opzionale e il valore predefinito è en-US. Elenco dei codici supportati
key La tua chiave API. Non hai una chiave? Ottenetela in un clic!.
Esempio di richiesta
https://api.textgears.com/suggest?key=DEMO_KEY&text=I+is+an+engeneer!+My+na

Invia la richiesta Il risultato sarà mostrato qui sotto

Risposta del server
                                            
{
    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"
            }
        ]
    }
}
                                            
                                        

Leggibilità del testo

https://api.textgears.com/readability

Calcolo della leggibilità del testo secondo gli algoritmi più comuni e i loro adattamenti per la maggior parte delle lingue. Potete saperne di più sulle metriche di leggibilità. leggendo il nostro articolo specifico.

Importante!

Quando si determina la metrica del testo, l'accuratezza è direttamente correlata alla dimensione del testo. Determinare la leggibilità o altri parametri del testo per una frase di due parole non ha senso. Si raccomanda di controllare i testi che hanno almeno 30 parole. Più sono, meglio è.

Parametri della richiesta
Parametro Descrizione
text Testo codificato UTF-8. Raccomandiamo di inviare testo puro senza tag HTML e caratteri UTF-8 non validi. La lunghezza massima è limitata dai parametri del tuo piano di fatturazione.
language Codice della lingua. È un parametro opzionale e il valore predefinito è en-US. Elenco dei codici supportati
key La tua chiave API. Non hai una chiave? Ottenetela in un clic!.
Esempio di richiesta
text
https://api.textgears.com/readability?key=DEMO_KEY&text=...

Invia la richiesta Il risultato sarà mostrato qui sotto

Risposta del server
                                            
{
    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
            }
        }
    }
}
                                            
                                        

Analisi del testo

https://api.textgears.com/analyze

Analisi completa del testo. Trova tutti i tipi di errori, calcola le metriche di leggibilità, valuta l'ortografia su una scala di 100 punti e valuta anche l'umore emotivo del testo.

Importante!

Quando si determina la metrica del testo, l'accuratezza è direttamente correlata alla dimensione del testo. Determinare la leggibilità o altri parametri del testo per una frase di due parole non ha senso. Si raccomanda di controllare i testi che hanno almeno 30 parole. Più sono, meglio è.

Parametri della richiesta
Parametro Descrizione
text Testo codificato UTF-8. Raccomandiamo di inviare testo puro senza tag HTML e caratteri UTF-8 non validi. La lunghezza massima è limitata dai parametri del tuo piano di fatturazione.
language Codice della lingua. È un parametro opzionale e il valore predefinito è en-US. Elenco dei codici supportati
whitelist Non richiesto. Array di parole e frasi che non devono essere rilevate come errori.
dictionary_id Non richiesto. Dizionario personalizzato id. Il dizionario è un gruppo di regole personalizzate. Creazione e modifica di dizionari.
key La tua chiave API. Non hai una chiave? Ottenetela in un clic!.
Esempio di richiesta
https://api.textgears.com/analyze?key=DEMO_KEY&text=...
Risposta del server
                                            
{
    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,
            }
        }
    }
}
                                            
                                        

Rilevamento della lingua

https://api.textgears.com/detect

Determinazione della lingua del testo e l'ipotesi del suo dialetto. Il metodo restituisce un array di opzioni probabili per ogni lingua. Se non è possibile identificare univocamente la lingua, il campo language restituisce null

Parametri della richiesta
Parametro Descrizione
text Testo codificato UTF-8. Raccomandiamo di inviare testo puro senza tag HTML e caratteri UTF-8 non validi. La lunghezza massima è limitata dai parametri del tuo piano di fatturazione.
key La tua chiave API. Non hai una chiave? Ottenetela in un clic!.
Esempio di richiesta
text
https://api.textgears.com/detect?key=DEMO_KEY&text=...

Invia la richiesta Il risultato sarà mostrato qui sotto

Risposta del server
                                            
{
    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,
        }
    }
}
                                            
                                        

Riassunto ed estrazione di parole chiave

https://api.textgears.com/summarize
Parametri della richiesta
Parametro Descrizione
text Testo codificato UTF-8. Raccomandiamo di inviare testo puro senza tag HTML e caratteri UTF-8 non validi. La lunghezza massima è limitata dai parametri del tuo piano di fatturazione.
language Codice della lingua. È un parametro opzionale e il valore predefinito è en-US. Elenco dei codici supportati
max_sentences < b>Parametro opzionale. Numero massimo di frasi nel riassunto
key La tua chiave API. Non hai una chiave? Ottenetela in un clic!.
Esempio di richiesta
language
text
https://api.textgears.com/summarize?key=DEMO_KEY&language=en-GB&text=...

Invia la richiesta Il risultato sarà mostrato qui sotto

Risposta del server
                                            
{
    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

Piano tariffario

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

Ricevere i dati sulla tariffa corrente del piano. Il metodo può essere utilizzato per tenere traccia di quante richieste all'interno del piano sono già state fatte, o quante richieste possono ancora essere fatte entro il periodo di fatturazione

Parametri della richiesta
Parametro Esempio Descrizione
key La tua chiave API. Non hai una chiave? Ottenetela in un clic!.
Esempio di richiesta
https://api.textgears.com/account/resourcequota?key=DEMO_KEY

Invia la richiesta Il risultato sarà mostrato qui sotto

Risposta del server
                                            
{
    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)
        },
    },
}
                                            
                                        

Statistiche di utilizzo

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

Ricevere le statistiche di utilizzo delle API per il proprio account con una ripartizione per giorno

Parametri della richiesta
Parametro Esempio Descrizione
period_start Inizio del periodo. Parametro opzionale..
period_end Fine del periodo. Parametro opzionale. Se il periodo non è specificato, vengono visualizzati i dati degli ultimi 30 giorni.
key La tua chiave API. Non hai una chiave? Ottenetela in un clic!.
Esempio di richiesta
https://api.textgears.com/account/usage?key=DEMO_KEY

Invia la richiesta Il risultato sarà mostrato qui sotto

Risposta del server
                                            
{
    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
        }
    ]
}
                                            
                                        

Creazione e modifica di dizionari

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

Se hai bisogno di un'impostazione flessibile per controllare il testo per gli errori, usa l'impostazione delle eccezioni personalizzate. Questo sarà particolarmente utile per le aziende che lavorano con testi che sono pieni di parole di un vocabolario speciale. Segna parole o frasi come "corrette" in modo che il sistema smetta di considerarle errori. Si può anche usare per permettere al sistema di trovare gli errori in base alla lista di parole specifiche. Le regole personalizzate possono essere combinate e trasformate in dizionari. Un tale approccio rende possibile che le diverse funzioni del vostro prodotto utilizzino un diverso insieme di regole. Allo stesso tempo, ogni utente del vostro prodotto può avere il proprio set di eccezioni

Parametri della richiesta
Parametro Descrizione
id Id del dizionario personalizzato. Sì, si imposta l'id da soli. Due diversi account possono creare dizionari con gli stessi id. Può essere un numero, una stringa o anche null.Il dizionario predefinito ha id === null. Sarà riempito con le eccezioni create senza il parametro dictionary_id..
title Titolo del dizionario. Lunghezza massima: 500 caratteri.
key La tua chiave API. Non hai una chiave? Ottenetela in un clic!.
https://api.textgears.com/custom/updatedictionary
Parametro Descrizione
id Id del dizionario. Può essere qualsiasi stringa fino a 64 caratteri o nulla..
title Titolo del dizionario. Lunghezza massima: 500 caratteri.
key La tua chiave API. Non hai una chiave? Ottenetela in un clic!.
https://api.textgears.com/custom/listdictionaries
Parametro Descrizione
limit Il numero massimo di record nel risultato. Non più di 500..
offset Quanti record saranno ignorati.
key La tua chiave API. Non hai una chiave? Ottenetela in un clic!.
https://api.textgears.com/custom/deletedictionary
Parametro Descrizione
id Id del dizionario. Può essere qualsiasi stringa fino a 64 caratteri o nulla.
key La tua chiave API. Non hai una chiave? Ottenetela in un clic!.

Aggiungi un'eccezione

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

Se stai controllando testi con un vocabolario molto specifico che è segnato come errore nel nostro sistema, puoi aggiungere parole o frasi alle eccezioni. Dopo di che, non saranno considerati errori.

Parametri della richiesta
Parametro Descrizione
text Una parola o un testo da marcare in un altro modo personalizzato. La lunghezza massima è di 500 caratteri.
type Tipo di eccezione. Valori possibili: 1 – text è un errore, 2 – text non è un errore.
lang Codice lingua. L'eccezione sarà applicata solo al testo in questa lingua.
description Non richiesto. Descrizione dell'eccezione personalizzata.
dictionary_id Parametro non richiesto. Dizionario personalizzato (un gruppo di eccezioni) id. Stringa, la lunghezza può essere fino a 64 caratteri o NULL.Puoi impostare il parametro dictionary_id mentre invii la richiesta analyze o check per scegliere un dizionario da applicare.
key La tua chiave API. Non hai una chiave? Ottenetela in un clic!.
Esempio di richiesta
https://api.textgears.com/custom/addexception?text=foobaring&type=2&lang=en-US&key=DEMO_KEY
Risposta del server
                                            
{
    status : true,
    response : {
        id: 20, // New exception id
        text: "foobaring",
        type: 1,
        lang: "en-US",
        creation_time: "2021-06-20T12:34:59+0000",
        update_time: null,
        description: null,
    },
}
                                            
                                        

Elenco delle eccezioni

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

Elenco delle parole di esclusione aggiunte in precedenza

Parametri della richiesta
Parametro Descrizione
limit Il numero massimo di record nel risultato. Non più di 500..
offset Quanti record ordinati per testo vengono saltati nell'output. Usato per l'output impaginato..
dictionary_id Non richiesto. Dizionario (gruppo di eccezioni) id. Per ottenere tutte le eccezioni del dizionario predefinito si può usare il valore null..
text Non richiesto. Filtro di testo.
type Non richiesto. Filtro del tipo di eccezione.
lang Non richiesto. Filtro della lingua.
key La tua chiave API. Non hai una chiave? Ottenetela in un clic!.
Esempio di richiesta
https://api.textgears.com/custom/addexception?text=foobaring&key=DEMO_KEY
Risposta del server
                                            
{
    status : true,
    response : {
        exceptions : [
            {
                id: 20,
                text: "foobaring",
                type: 1,
                lang: "en-US",
                creation_time: "2021-06-20T12:34:59+0000",
                update_time: null,
                description: null,
            },
        ],
    },
}
                                            
                                        

Rimuovere l'eccezione

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

Elimina la parola di esclusione per il controllo. Se si tenta di cancellare una parola precedentemente eliminata, non si verifica alcun errore.

Parametri della richiesta
Parametro Descrizione
id ID dell'eccezione da rimuovere..
dictionary_id Id del dizionario. Può essere qualsiasi stringa fino a 64 caratteri o null.
key La tua chiave API. Non hai una chiave? Ottenetela in un clic!.
Esempio di richiesta
https://api.textgears.com/custom/deleteexception?id=20&key=DEMO_KEY
Risposta del server
                                            
{
    status : true,
    response : {}
}