Documentação da API de verificação gramatical e ortográfica

A API Textgears permite-lhe integrar as mais recentes tecnologias para análise de texto, virtualmente a qualquer produto. De aplicações móveis simples até desenvolvimentos corporativos volumosos. A API permite-lhe verificar o texto para todos os tipos de erros de forma flexível, determinar a legibilidade do texto, avaliar o vocabulário aproximado do autor e muito mais.

O que pode a API fazer?

Documentos para Postman

Você pode transferir o ficheiro de documentação da API para Postman ou qualquer outro programa de depuração HTTP. No Postman você pode definir uma chave no separador Variáveis..

Download TextGears.postman.json

Onde começar

É simples e fácil. A API está disponível para pedidos HTTP e HTTPS normais. Os dados de saída são enviados em JSON. Todos os pedidos são feitos para o servidor api.textgears.com

Para acelerar o acesso a partir de diferentes partes do mundo, colocamos servidores em 3 países: EUA, Estónia e Singapura. Ao enviar um pedido para api.textgears.com, escolhemos o cluster mais próximo. Mas você pode fazer pedidos explicitamente para o cluster localizado mais próximo de si para reduzir o atraso na recepção de uma resposta.

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

Todos os endpoints da API são clusters independentes de servidores. Garantimos uma capacidade de serviço de 99.9% para cada um deles. Se tal lhe parecer insuficiente, você pode alterar o cluster quando ocorrer um erro de ligação.

                                                    
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 implementou uma biblioteca para trabalhar com a API noutra língua ou para outra framework, basta enviar-nos um link no GitHub ou no GitLab, também o publicaremos.

Línguas suportadas

A TextGears analisa o texto não tendo apenas em conta a língua do texto, mas também mantendo o dialeto em mente. Lista completa de línguas suportadas: Inglês, Francês, Alemão, Português, Italiano, Espanhol, Russo, Japonês, Chinês, Grego

Dialetos suportados (tem que ser enviado no parâmetro 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, ru-RU, es-ES, ja-JP, zh-CN, el-GR

Autorização e transferência de parâmetros

A solicitação é autorizada transferindo a sua chave entre outros parâmetros de uma das seguintes formas:

  • POST parameter key
  • GET parameter key
    ?key=YOURKEY
  • Json-request
    {
        "key": "YOURKEY",
        // Other params
    }
  • HTTP Header
    Authorization: Basic YOURKEY
    Onde YOURKEY é a sua chave.

Códigos de erro

Em caso de erro, o parâmetro status terá o valor false

{
    status : false,
    error_code : 600,  // API error code
    description : "Invalid license key. Go to https://textgears.com/signup.php to get one"
}
  • 600 - Chave inválida
  • 606 - Língua não suportada
  • 607 - Número permitido de pedidos excedido
  • 500 - Erro de serviço interno desconhecido
  • 501 - O comprimento do texto excede o limite da taxa

API de validação de texto

A verificar a gramática do texto

https://api.textgears.com/grammar

O método permite-lhe verificar o texto quanto a erros gramaticais, ortográficos, de pontuação e de estilo.

Parâmetros do pedido
Parâmetro Exemplo Descrição
text Texto codificado UTF-8. Recomendamos o envio de texto puro sem tags HTML e caracteres UTF-8 inválidos. O comprimento máximo é limitado pelos parâmetros do seu plano de faturamento.
language Código de língua. É um parâmetro opcional, e o valor padrão é en-US. Lista de códigos suportados
whitelist Não necessário. Matriz de palavras e frases que não devem ser detectadas como erros.
dictionary_id Não necessário. Id de dicionário personalizado. O dicionário é um grupo de regras personalizadas. Criar e editar dicionários.
key A sua chave API. Não tem uma chave? Obtenha-a num clique!.
Exemplo de pedido
https://api.textgears.com/grammar?key=DEMO_KEY&text=I+is+an+engeneer!&language=en-GB

Enviar pedido O resultado será mostrado abaixo

Resposta do servidor
                                            
{
    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"
            }
        ]
    }
}
                                            
                                        

A verfificar a ortografia do texto

https://api.textgears.com/spelling

O método verifica o texto em busca de erros de introdução usando o dicionário atualizado

Parâmetros do pedido
Parâmetro Exemplo Descrição
text Texto codificado UTF-8. Recomendamos o envio de texto puro sem tags HTML e caracteres UTF-8 inválidos. O comprimento máximo é limitado pelos parâmetros do seu plano de faturamento.
language Código de língua. É um parâmetro opcional, e o valor padrão é en-US. Lista de códigos suportados
whitelist Não necessário. Matriz de palavras e frases que não devem ser detectadas como erros.
dictionary_id Não necessário. Id de dicionário personalizado. O dicionário é um grupo de regras personalizadas. Criar e editar dicionários.
key A sua chave API. Não tem uma chave? Obtenha-a num clique!.
Exemplo de pedido
https://api.textgears.com/spelling?key=DEMO_KEY&text=I+is+an+engeneer!&language=en-GB

Enviar pedido O resultado será mostrado abaixo

Resposta do servidor
                                            
{
    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"
            }
        ]
    }
}
                                            
                                        

A corrigir automaticamente o texto

https://api.textgears.com/suggest

O sistema de verificação corrige automaticamente erros no texto e sugere uma continuação da última frase.

Importante!

Se for encontrado um erro de introdução, a palavra é substituída pela palavra mais próxima do dicionário. Se houver várias palavras semelhantes à detectada, então a palavra mais comum na fala moderna é escolhida. O TextGears ainda está longe de telepatia, portanto, se houver muitos erros de escrita o significado do texto final pode mudar.

Parâmetros do pedido
Parâmetro Exemplo Descrição
text Texto codificado UTF-8. Recomendamos o envio de texto puro sem tags HTML e caracteres UTF-8 inválidos. O comprimento máximo é limitado pelos parâmetros do seu plano de faturamento.
language Código de língua. É um parâmetro opcional, e o valor padrão é en-US. Lista de códigos suportados
key A sua chave API. Não tem uma chave? Obtenha-a num clique!.
Exemplo de pedido
https://api.textgears.com/suggest?key=DEMO_KEY&text=I+is+an+engeneer!+My+na

Enviar pedido O resultado será mostrado abaixo

Resposta do servidor
                                            
{
    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"
            }
        ]
    }
}
                                            
                                        

Legibilidade do texto

https://api.textgears.com/readability

Cálculo da legibilidade do texto de acordo com os algoritmos mais comuns e suas adaptações para a maioria das línguas. Você pode saber mais sobre métricas de legibilidade. ao ler o nosso artigo separado.

Importante!

Ao determinar métricas de texto, a precisão está diretamente relacionada ao tamanho do texto. Determinar a legibilidade ou outros parâmetros do texto para uma frase de duas palavras não faz qualquer sentido. Recomenda-se verificar textos que tenham pelo menos 30 palavras. Quanto mais, melhor.

Parâmetros do pedido
Parâmetro Descrição
text Texto codificado UTF-8. Recomendamos o envio de texto puro sem tags HTML e caracteres UTF-8 inválidos. O comprimento máximo é limitado pelos parâmetros do seu plano de faturamento.
language Código de língua. É um parâmetro opcional, e o valor padrão é en-US. Lista de códigos suportados
key A sua chave API. Não tem uma chave? Obtenha-a num clique!.
Exemplo de pedido
text
https://api.textgears.com/readability?key=DEMO_KEY&text=...

Enviar pedido O resultado será mostrado abaixo

Resposta do servidor
                                            
{
    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
            }
        }
    }
}
                                            
                                        

Análise de texto

https://api.textgears.com/analyze

Análise de texto abrangente. Ela encontra todos os tipos de erros, calcula métricas de legibilidade, classifica ortografia numa escala de 100 pontos e também avalia o sentimento emocional do texto.

Importante!

Ao determinar métricas de texto, a precisão está diretamente relacionada ao tamanho do texto. Determinar a legibilidade ou outros parâmetros do texto para uma frase de duas palavras não faz qualquer sentido. Recomenda-se verificar textos que tenham pelo menos 30 palavras. Quanto mais, melhor.

Parâmetros do pedido
Parâmetro Descrição
text Texto codificado UTF-8. Recomendamos o envio de texto puro sem tags HTML e caracteres UTF-8 inválidos. O comprimento máximo é limitado pelos parâmetros do seu plano de faturamento.
language Código de língua. É um parâmetro opcional, e o valor padrão é en-US. Lista de códigos suportados
whitelist Não necessário. Matriz de palavras e frases que não devem ser detectadas como erros.
dictionary_id Não necessário. Id de dicionário personalizado. O dicionário é um grupo de regras personalizadas. Criar e editar dicionários.
key A sua chave API. Não tem uma chave? Obtenha-a num clique!.
Exemplo de pedido
https://api.textgears.com/analyze?key=DEMO_KEY&text=...
Resposta do servidor
                                            
{
    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,
            }
        }
    }
}
                                            
                                        

Detecção de língua

https://api.textgears.com/detect

Determinação da língua do texto e a suposição do seu dialeto. O método retorna uma matriz de opções prováveis para cada língua. Se não for possível identificar inequivocamente a língua, o campo language devolve null

Parâmetros do pedido
Parâmetro Descrição
text Texto codificado UTF-8. Recomendamos o envio de texto puro sem tags HTML e caracteres UTF-8 inválidos. O comprimento máximo é limitado pelos parâmetros do seu plano de faturamento.
key A sua chave API. Não tem uma chave? Obtenha-a num clique!.
Exemplo de pedido
text
https://api.textgears.com/detect?key=DEMO_KEY&text=...

Enviar pedido O resultado será mostrado abaixo

Resposta do servidor
                                            
{
    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,
        }
    }
}
                                            
                                        

Sumarização e extração de palavras-chave

https://api.textgears.com/summarize
Parâmetros do pedido
Parâmetro Descrição
text Texto codificado UTF-8. Recomendamos o envio de texto puro sem tags HTML e caracteres UTF-8 inválidos. O comprimento máximo é limitado pelos parâmetros do seu plano de faturamento.
language Código de língua. É um parâmetro opcional, e o valor padrão é en-US. Lista de códigos suportados
max_sentences Parâmetro opcional. Número máximo de frases em resumo
key A sua chave API. Não tem uma chave? Obtenha-a num clique!.
Exemplo de pedido
language
text
https://api.textgears.com/summarize?key=DEMO_KEY&language=en-GB&text=...

Enviar pedido O resultado será mostrado abaixo

Resposta do servidor
                                            
{
    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

Cota do plano

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

Receber dados sobre a cota do plano atual. O método pode ser usado para rastrear quantos pedidos dentro do plano já foram feitos, ou quantos pedidos ainda podem ser feitos dentro do período de cobrança

Parâmetros do pedido
Parâmetro Exemplo Descrição
key A sua chave API. Não tem uma chave? Obtenha-a num clique!.
Exemplo de pedido
https://api.textgears.com/account/resourcequota?key=DEMO_KEY

Enviar pedido O resultado será mostrado abaixo

Resposta do servidor
                                            
{
    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)
        },
    },
}
                                            
                                        

Estatísticas de utilização

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

Obtendo estatísticas de uso da API para a sua conta com detalhe ao dia

Parâmetros do pedido
Parâmetro Exemplo Descrição
period_start Início do período. Parâmetro opcional..
period_end Fim do período. Parâmetro opcional. Se o período não for especificado, serão exibidos os dados dos últimos 30 dias.
key A sua chave API. Não tem uma chave? Obtenha-a num clique!.
Exemplo de pedido
https://api.textgears.com/account/usage?key=DEMO_KEY

Enviar pedido O resultado será mostrado abaixo

Resposta do servidor
                                            
{
    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
        }
    ]
}
                                            
                                        

Criar e editar dicionários

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

Se precisar de uma configuração flexível para verificar se há erros no texto, use a configuração de exceções personalizadas. Isto será especialmente útil para empresas que trabalham com textos cheios de palavras de um vocabulário especial. Marque palavras ou frases como “corretas” para que o sistema pare de considerá-las erros. Você também pode usá-la para permitir que o sistema encontre erros de acordo com a lista de palavras específicas. Regras personalizadas podem ser combinadas e transformadas em dicionários. Tal abordagem possibilita que as diferentes funções do seu produto usem um conjunto diferente de regras. Ao mesmo tempo, cada utilizador do seu produto pode ter o seu próprio conjunto de exceções

Parâmetros do pedido
Parâmetro Descrição
id Id do dicionário personalizado. Sim, você definiu a identificação por si próprio. Duas contas diferentes podem criar dicionários com os mesmos IDs. Pode ser um número, uma string ou mesmo null. O dicionário padrão tem id === null. Ele será preenchido com exceções criadas sem o parâmetro dictionary_id.
title Título do dicionário. Comprimento máximo: 500 caracteres.
key A sua chave API. Não tem uma chave? Obtenha-a num clique!.
https://api.textgears.com/custom/updatedictionary
Parâmetro Descrição
id Id do dicionário. Pode ser qualquer string de até 64 caracteres ou nulo.
title Título do dicionário. Comprimento máximo: 500 caracteres.
key A sua chave API. Não tem uma chave? Obtenha-a num clique!.
https://api.textgears.com/custom/listdictionaries
Parâmetro Descrição
limit O número máximo de registos no resultado. Não mais do que 500..
offset Quantos registos serão ignorados.
key A sua chave API. Não tem uma chave? Obtenha-a num clique!.
https://api.textgears.com/custom/deletedictionary
Parâmetro Descrição
id Id do dicionário. Pode ser qualquer string de até 64 caracteres ou nulo
key A sua chave API. Não tem uma chave? Obtenha-a num clique!.

Adicionar uma exceção

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

Se estiver a verificar textos com vocabulário muito específico que esteja marcado como erros no nosso sistema, você pode adicionar palavras ou frases a exceções. Depois disso, eles não serão considerados erros.

Parâmetros do pedido
Parâmetro Descrição
text Uma palavra ou um texto a ser marcado de outra forma personalizada. O comprimento máximo é de 500 caracteres.
type Tipo de exceção. Valores possíveis: 1 — text é um erro, 2 — text NÃO é um erro.
lang Código de língua. A exceção será aplicada apenas ao texto nesta língua.
description Não é necessário. Descrição de exceção personalizada.
dictionary_id Parâmetro não obrigatório. Dicionário personalizado (um grupo de exceções) id. String, comprimento pode ser de até 64 caracteres ou NULL. Você pode definir o parâmetro dictionary_id ao enviar o pedido de analyze ou check para escolher um dicionário a ser aplicado.
key A sua chave API. Não tem uma chave? Obtenha-a num clique!.
Exemplo de pedido
https://api.textgears.com/custom/addexception?text=foobaring&type=2&lang=en-US&key=DEMO_KEY
Resposta do servidor
                                            
{
    status : true,
    response : {
        id: 20, // New exception id
        text: "foobaring",
        type: 1,
        lang: "en-US",
        creation_time: "2021-09-22T08:08:54+0000",
        update_time: null,
        description: null,
    },
}
                                            
                                        

Lista de exceções

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

Listar palavras de exclusão adicionadas anteriormente

Parâmetros do pedido
Parâmetro Descrição
limit O número máximo de registos no resultado. Não mais do que 500..
offset Quantos registos ordenados por texto são ignorados na saída. Usado para saída paginada..
dictionary_id Não necessário. ID do dicionário (grupo de exceções). Para obter todas as exceções do dicionário padrão, você pode usar o valor null.
text Não necessário. Filtro de texto.
type Não necessário. Filtro de tipo de exceção.
lang Não necessário. Filtro de língua.
key A sua chave API. Não tem uma chave? Obtenha-a num clique!.
Exemplo de pedido
https://api.textgears.com/custom/addexception?text=foobaring&key=DEMO_KEY
Resposta do servidor
                                            
{
    status : true,
    response : {
        exceptions : [
            {
                id: 20,
                text: "foobaring",
                type: 1,
                lang: "en-US",
                creation_time: "2021-09-22T08:08:54+0000",
                update_time: null,
                description: null,
            },
        ],
    },
}
                                            
                                        

Remover exceção

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

Remova a palavra de exceção para verificação. Se você tentar excluir uma palavra excluída anteriormente, não ocorrerá nenhum erro.

Parâmetros do pedido
Parâmetro Descrição
id ID de exceção a ser removido..
dictionary_id Id do dicionário. Pode ser qualquer string de até 64 caracteres ou null.
key A sua chave API. Não tem uma chave? Obtenha-a num clique!.
Exemplo de pedido
https://api.textgears.com/custom/deleteexception?id=20&key=DEMO_KEY
Resposta do servidor
                                            
{
    status : true,
    response : {}
}