Documentación de la API de revisión gramatical y ortográfica

La API de Textgears le permite integrar las últimas tecnologías de análisis de texto prácticamente en cualquier producto. La API le permite comprobar el texto en busca de todo tipo de errores de forma flexible, determinar la legibilidad del texto, evaluar el vocabulario aproximado del autor y mucho más.

¿Qué puede hacer la API?

Documentos para Postman

Puede descargar el archivo de documentación de la API para Postman o cualquier otro programa de depuración HTTP. En Postman puede establecer una clave en la pestaña Variables de la colección..

Download TextGears.postman.json

Dónde empezar

Es simple y fácil. La API está disponible para peticiones regulares HTTP y HTTPS.Los datos de salida se envían en JSON. Todas las peticiones se realizan al servidor api.textgears.com

Para agilizar el acceso desde distintas partes del mundo, hemos colocado servidores en 3 países: Estados Unidos, Estonia y Singapur. Al enviar una solicitud a api.textgears.com elegiremos el clúster más cercano. Pero puede hacer peticiones explícitamente al clúster situado cerca para reducir el retraso en la recepción de una respuesta.

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

Todos los puntos finales de la API son clústeres de servidores independientes. Garantizamos un 99,9% de capacidad de servicio para cada uno de ellos. Si esto le parece insuficiente, puede cambiar el clúster cuando se produzca un error de conexión.

                                                    
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 ha implementado una librería para trabajar con la API en otro lenguaje o para otro framework, sólo tiene que enviarnos un enlace en GitHub o GitLab, y nosotros lo publicaremos también.

Idiomas soportados

TextGears analiza el texto no sólo teniendo en cuenta el idioma del mismo, sino también el dialecto. Lista completa de idiomas compatibles: Inglés, francés, alemán, portugués, italiano, español, ruso, japonés, chino, griego

Los dialectos soportados (tienen que ser enviados en el 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

Autorización y transferencia de parámetros

La solicitud se autoriza transfiriendo su clave, entre otros parámetros, de una de las siguientes maneras:

  • POST parameter key
  • GET parameter key
    ?key=YOURKEY
  • Json-request
    {
        "key": "YOURKEY",
        // Other params
    }
  • HTTP Header
    Authorization: Basic YOURKEY
    Donde YOURKEY es su clave.

Códigos de error

En caso de error, el parámetro estado tendrá un valor falso

{
    status : false,
    error_code : 600,  // API error code
    description : "Invalid license key. Go to https://textgears.com/signup.php to get one"
}
  • 600 - Clave no válida
  • 606 - Idioma no soportado
  • 607 - Número de peticiones permitido superado
  • 500 - Error de servicio interno desconocido
  • 501 - La longitud del texto supera el límite de la tasa
  • .

API de validación de texto

Revisando la gramática del texto

https://api.textgears.com/grammar

El método permite comprobar si el texto tiene errores gramaticales, ortográficos, de puntuación y de estilo.

Solicitar parámetros
Parámetro Ejemplo Descripción
text Texto codificado en UTF-8. Recomendamos enviar texto puro sin etiquetas HTML ni caracteres UTF-8 no válidos. La longitud máxima está limitada por los parámetros de su plan de facturación.
language Código de idioma. Es un parámetro opcional, y el valor por defecto es en-US. Lista de códigos soportados
whitelist No se requiere. Conjunto de palabras y frases que no deben detectarse como errores.
dictionary_id No se requiere. Id. de diccionario personalizado. El diccionario es un grupo de reglas personalizadas. Crear y editar diccionarios.
key Su clave API. ¿No tiene una clave? ¡Obténgala con un click!.
Ejemplo de solicitud
https://api.textgears.com/grammar?key=DEMO_KEY&text=I+is+an+engeneer!&language=en-GB

Enviar solicitud El resultado se mostrará a continuación

Respuesta del 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"
            }
        ]
    }
}
                                            
                                        

Revisando la ortografía del texto

https://api.textgears.com/spelling

El método revisa el texto en busca de errores tipográficos utilizando el diccionario actualizado

Solicitar parámetros
Parámetro Ejemplo Descripción
text Texto codificado en UTF-8. Recomendamos enviar texto puro sin etiquetas HTML ni caracteres UTF-8 no válidos. La longitud máxima está limitada por los parámetros de su plan de facturación.
language Código de idioma. Es un parámetro opcional, y el valor por defecto es en-US. Lista de códigos soportados
whitelist No se requiere. Conjunto de palabras y frases que no deben detectarse como errores.
dictionary_id No se requiere. Id. de diccionario personalizado. El diccionario es un grupo de reglas personalizadas. Crear y editar diccionarios.
key Su clave API. ¿No tiene una clave? ¡Obténgala con un click!.
Ejemplo de solicitud
https://api.textgears.com/spelling?key=DEMO_KEY&text=I+is+an+engeneer!&language=en-GB

Enviar solicitud El resultado se mostrará a continuación

Respuesta del 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"
            }
        ]
    }
}
                                            
                                        

Autocorrigiendo el texto

https://api.textgears.com/suggest

El sistema de verificación corrige automáticamente los errores del texto y sugiere la continuación de la última frase.

¡Importante!

Si se encuentra una errata, la palabra se sustituye por la más parecida del diccionario. Si hay varias palabras parecidas a la detectada, se elige la más común en el habla moderna. TextGears aún está lejos de la telepatía, por lo que si hay muchas erratas el significado del texto final puede cambiar.

Solicitar parámetros
Parámetro Ejemplo Descripción
text Texto codificado en UTF-8. Recomendamos enviar texto puro sin etiquetas HTML ni caracteres UTF-8 no válidos. La longitud máxima está limitada por los parámetros de su plan de facturación.
language Código de idioma. Es un parámetro opcional, y el valor por defecto es en-US. Lista de códigos soportados
key Su clave API. ¿No tiene una clave? ¡Obténgala con un click!.
Ejemplo de solicitud
https://api.textgears.com/suggest?key=DEMO_KEY&text=I+is+an+engeneer!+My+na

Enviar solicitud El resultado se mostrará a continuación

Respuesta del 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"
            }
        ]
    }
}
                                            
                                        

Legibilidad del texto

https://api.textgears.com/readability

Cálculo de la legibilidad del texto según los algoritmos más comunes y sus adaptacionespara la mayoría de los idiomas. Puede obtener más información sobre las métricas de legibilidad leyendo nuestro artículo independiente.

¡Importante!

A la hora de determinar las métricas del texto, la precisión está directamente relacionada con el tamaño del mismo. Determinar la legibilidad u otros parámetros del texto para una frase de dos palabras no tiene sentido. Se recomienda comprobar los textos que tengan al menos 30 palabras. Cuantas más, mejor.

Solicitar parámetros
Parámetro Descripción
text Texto codificado en UTF-8. Recomendamos enviar texto puro sin etiquetas HTML ni caracteres UTF-8 no válidos. La longitud máxima está limitada por los parámetros de su plan de facturación.
language Código de idioma. Es un parámetro opcional, y el valor por defecto es en-US. Lista de códigos soportados
key Su clave API. ¿No tiene una clave? ¡Obténgala con un click!.
Ejemplo de solicitud
text
https://api.textgears.com/readability?key=DEMO_KEY&text=...

Enviar solicitud El resultado se mostrará a continuación

Respuesta del 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álisis de Texto

https://api.textgears.com/analyze

Análisis exhaustivo del texto. Encuentra todo tipo de errores, calcula las métricas de legibilidad, califica la ortografía en una escala de 100 puntos y también evalúa el estado emocional del texto.

¡Importante!

A la hora de determinar las métricas del texto, la precisión está directamente relacionada con el tamaño del mismo. Determinar la legibilidad u otros parámetros del texto para una frase de dos palabras no tiene sentido. Se recomienda comprobar los textos que tengan al menos 30 palabras. Cuantas más, mejor.

Solicitar parámetros
Parámetro Descripción
text Texto codificado en UTF-8. Recomendamos enviar texto puro sin etiquetas HTML ni caracteres UTF-8 no válidos. La longitud máxima está limitada por los parámetros de su plan de facturación.
language Código de idioma. Es un parámetro opcional, y el valor por defecto es en-US. Lista de códigos soportados
whitelist No se requiere. Conjunto de palabras y frases que no deben detectarse como errores.
dictionary_id No se requiere. Id. de diccionario personalizado. El diccionario es un grupo de reglas personalizadas. Crear y editar diccionarios.
key Su clave API. ¿No tiene una clave? ¡Obténgala con un click!.
Ejemplo de solicitud
https://api.textgears.com/analyze?key=DEMO_KEY&text=...
Respuesta del 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,
            }
        }
    }
}
                                            
                                        

Detección de idioma

https://api.textgears.com/detect

Determinación del idioma del texto y de la suposición de su dialecto.El método devuelve una matriz de opciones probables para cada idioma.Si no es posible identificar inequívocamente el idioma, el campo de idiomase vuelve nulo

Solicitar parámetros
Parámetro Descripción
text Texto codificado en UTF-8. Recomendamos enviar texto puro sin etiquetas HTML ni caracteres UTF-8 no válidos. La longitud máxima está limitada por los parámetros de su plan de facturación.
key Su clave API. ¿No tiene una clave? ¡Obténgala con un click!.
Ejemplo de solicitud
text
https://api.textgears.com/detect?key=DEMO_KEY&text=...

Enviar solicitud El resultado se mostrará a continuación

Respuesta del 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,
        }
    }
}
                                            
                                        

Resumir y extraer palabras clave

https://api.textgears.com/summarize
Solicitar parámetros
Parámetro Descripción
text Texto codificado en UTF-8. Recomendamos enviar texto puro sin etiquetas HTML ni caracteres UTF-8 no válidos. La longitud máxima está limitada por los parámetros de su plan de facturación.
language Código de idioma. Es un parámetro opcional, y el valor por defecto es en-US. Lista de códigos soportados
max_sentences Parámetro opcional. Número máximo de frases en el resumen
key Su clave API. ¿No tiene una clave? ¡Obténgala con un click!.
Ejemplo de solicitud
language
text
https://api.textgears.com/summarize?key=DEMO_KEY&language=en-GB&text=...

Enviar solicitud El resultado se mostrará a continuación

Respuesta del 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

Cuota del Plan

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

Recibir datos sobre la cuota actual del plan. El método puede utilizarse para saber cuántas solicitudes dentro del plan se han realizado ya, o cuántas solicitudes pueden realizarse todavía dentro del periodo de facturación

Solicitar parámetros
Parámetro Ejemplo Descripción
key Su clave API. ¿No tiene una clave? ¡Obténgala con un click!.
Ejemplo de solicitud
https://api.textgears.com/account/resourcequota?key=DEMO_KEY

Enviar solicitud El resultado se mostrará a continuación

Respuesta del 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)
        },
    },
}
                                            
                                        

Estadísticas de Uso

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

Obtención de estadísticas de uso de la API para su cuenta con un desglose por días

Solicitar parámetros
Parámetro Ejemplo Descripción
period_start Comienzo del periodo. Parámetro opcional..
period_end Fin del período. Parámetro opcional. Si no se especifica el periodo, se muestran los datos de los últimos 30 días.
key Su clave API. ¿No tiene una clave? ¡Obténgala con un click!.
Ejemplo de solicitud
https://api.textgears.com/account/usage?key=DEMO_KEY

Enviar solicitud El resultado se mostrará a continuación

Respuesta del 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
        }
    ]
}
                                            
                                        

Crear y editar diccionarios

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

Si necesita una configuración flexible para la comprobación de errores en el texto, utilice la configuración de excepciones personalizadas. Esto será especialmente útil para las empresas que trabajan con textos llenos de palabras de un vocabulario especial. Marque palabras o frases como "correctas" para que el sistema deje de considerarlas como errores. También puede utilizarlo para que el sistema encuentre errores según la lista de palabras específicas. Las reglas personalizadas pueden combinarse y transformarse en diccionarios. Este enfoque permite que las distintas funciones de su producto utilicen un conjunto de reglas diferente. Al mismo tiempo, cada usuario de su producto puede tener su propio conjunto de excepciones

Solicitar parámetros
Parámetro Descripción
id Id del diccionario personalizado. Sí, usted mismo establece el id. Dos cuentas diferentes pueden crear diccionarios con los mismos ids.Puede ser un número, una cadena o incluso null.El diccionario por defecto tiene id === null. Se llenará con las excepciones creadas sin el parámetro diccionario_id..
title Título del Diccionario. Largo máximo: 500 caracteres.
key Su clave API. ¿No tiene una clave? ¡Obténgala con un click!.
https://api.textgears.com/custom/updatedictionary
Parámetro Descripción
id Id. del diccionario. Puede ser cualquier cadena de hasta 64 caracteres o nulo.
title Título del Diccionario. Largo máximo: 500 caracteres.
key Su clave API. ¿No tiene una clave? ¡Obténgala con un click!.
https://api.textgears.com/custom/listdictionaries
Parámetro Descripción
limit El número máximo de registros en el resultado. No más de 500..
offset Cuántos registros serán ignorados.
key Su clave API. ¿No tiene una clave? ¡Obténgala con un click!.
https://api.textgears.com/custom/deletedictionary
Parámetro Descripción
id Id. del diccionario. Puede ser cualquier cadena de hasta 64 caracteres o nulo
key Su clave API. ¿No tiene una clave? ¡Obténgala con un click!.

Agregar una excepción

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

Si está revisando textos con un vocabulario muy específico que está marcado como errores en nuestro sistema, puede añadir palabras o frases a las excepciones. Después, no se considerarán errores.

Solicitar parámetros
Parámetro Descripción
text Una palabra o un texto para marcar de otra manera personalizada. La longitud máxima es de 500 caracteres.
type Tipo de excepción. Valores posibles: 1 – texto ES un error, 2 – texto NO es un error.
lang Código de idioma. La excepción se aplicará sólo al texto en este idioma.
description No es necesario. Descripción personalizada de la excepción.
dictionary_id Parámetro no obligatorio. Diccionario personalizado (un grupo de excepciones) id. Cadena, la longitud puede ser de hasta 64 caracteres o NULO.Puede establecer el parámetro diccionario_id al enviar la solicitud analizar o comprobar para elegir un diccionario que se aplicará.
key Su clave API. ¿No tiene una clave? ¡Obténgala con un click!.
Ejemplo de solicitud
https://api.textgears.com/custom/addexception?text=foobaring&type=2&lang=en-US&key=DEMO_KEY
Respuesta del servidor
                                            
{
    status : true,
    response : {
        id: 20, // New exception id
        text: "foobaring",
        type: 1,
        lang: "en-US",
        creation_time: "2021-09-22T07:45:00+0000",
        update_time: null,
        description: null,
    },
}
                                            
                                        

Lista de excepciones

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

Lista de palabras de exclusión añadidas previamente

Solicitar parámetros
Parámetro Descripción
limit El número máximo de registros en el resultado. No más de 500..
offset Cuántos registros ordenados por texto se saltan en la salida. Se utiliza para la salida paginada..
dictionary_id No se requiere. Id del diccionario (grupo de excepciones). Para obtener todas las excepciones del diccionario por defecto puede utilizar el valor nulo.
text No se requiere. Filtro de texto.
type No se requiere. Filtro de tipo de excepción.
lang No se requiere. Filtro de idioma.
key Su clave API. ¿No tiene una clave? ¡Obténgala con un click!.
Ejemplo de solicitud
https://api.textgears.com/custom/addexception?text=foobaring&key=DEMO_KEY
Respuesta del servidor
                                            
{
    status : true,
    response : {
        exceptions : [
            {
                id: 20,
                text: "foobaring",
                type: 1,
                lang: "en-US",
                creation_time: "2021-09-22T07:45:00+0000",
                update_time: null,
                description: null,
            },
        ],
    },
}
                                            
                                        

Eliminar excepción

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

Elimine la palabra de excepción para su comprobación. Si se intenta eliminar una palabra previamente eliminada, no se produce ningún error.

Solicitar parámetros
Parámetro Descripción
id ID de excepción a eliminar..
dictionary_id Id. del diccionario. Puede ser cualquier cadena de hasta 64 caracteres o null.
key Su clave API. ¿No tiene una clave? ¡Obténgala con un click!.
Ejemplo de solicitud
https://api.textgears.com/custom/deleteexception?id=20&key=DEMO_KEY
Respuesta del servidor
                                            
{
    status : true,
    response : {}
}