• Compartir

1 ¿Qué es Stilus API?

Stilus API es la plataforma de Stilus para desarrolladores que permite integrar, de forma personalizada, la potencia de este servicio de corrección en cualquier entorno de edición (ya sea propio o de terceros).

Su uso es muy sencillo. Su funcionamiento exige disponer de conexión a Internet para llevar a cabo la autenticación del usuario y la contabilidad del consumo del servicio. Y las peticiones se hacen mediante GET o POST a los puntos de entrada de la API, en función de la previa configuración lingüística con la que desee orientar la revisión.

Regístrese en Stilus para obtener un saldo gratuito que le permita probar la demo. Para proceder a su integración, atienda a la siguiente descripción o solicite presupuesto en caso de preferir contratarla. En cualquier caso, contacte para convenir el volumen de revisión que necesite.

2 Punto de entrada

El punto de entrada de la API es:

  • http://«server»/«root path»/api/stilus.php

3 Petición

Las peticiones se hacen mediante GET o POST a alguno de los puntos de entrada de la API. Los parámetros son los siguientes:

ParámetroDescripciónValoresRequerido
keyToken de autorización para realizar peticiones a la API. Se puede obtener una clave válida gratuita creando una cuenta en MeaningCloudString
txtTexto que se desea procesarString
urlURL cuyo contenido se desea revisar. Actualmente solo se soportan los HTTP y FTP no autenticados. Más información sobre los tipos de contenido soportados por los contenidos URL aquí.StringNo
ilangEspecifica el idioma de interfaz en el que aparecerán los mensajes asociados a las sugerencias de corrección.EN: inglés
ES: español
No
Por defecto: ES
modeDetermina el modo en que se presentan los errores localizados en el texto.all: Devuelve todos los errores encontrados en el texto.
next: Devuelve solo el primer error encontrado. En combinación con el parámetro offset, permite obtener, uno por uno, todos los errores del texto.
No
Por defecto: all
versionVersión de la APIStringNo
ifFormato de la entradaStringNo
Por defecto: html
ofFormato de la salidaxml, jsonNo
Por defecto: json
verboseStringNo
Por defecto: off
prettyprintStringNo
Por defecto: off
offsetEl offset indica el primer carácter donde comienza la revisión. Se usa junto con mode=next cuando la aplicación que llama a la API necesita recibir los errores del texto de uno en uno..Número positivo que puede ir desde 0 al que indique la posición del último carácter del texto.No
Por defecto: 0
dicEspecifica la lista de diccionarios activos que se usarán durante la revisión. Cada diccionario se representa con una letra (detallado abajo). Hay dos tipos de diccionarios: temáticos (con términos especializados por disciplinas) y de variantes lingüísticas (con léxico propio de variantes de español americano).Ver la sección de diccionarios (abajo).No
Por defecto: chetsdpqr
ppDetección inteligente de palabras prefijadas.y: activado n: desactivadoNo
Por defecto: y
aqoiManejo inteligente de palabras escritas en cursiva o entre comillas.y: activado n: desactivadoNo
Por defecto: y
tlsAviso sobre frases demasiado largas.y: activado n: desactivadoNo
Por defecto: y
dpnDetección inteligente de nombres propios.y: activado n: desactivadoNo
Por defecto: n
stmeDetermina el comportamiento ante frases con varios errores.0: Comprobar todas
1: Agrupar e ignorar
2: Agrupar y advertir
No
Por defecto: 2
redLocaliza tautologías y uso excesivo de preposiciones o conjunciones.y: activado n: desactivadoNo
Por defecto: y
spaComprueba el espaciado.y: activado n: desactivadoNo
Por defecto: y
comppuncVerifica la apertura y el cierre de los pares de signos.y: activado n: desactivadoNo
Por defecto: y
corrpuncVerifica el uso de los signos de puntuación.y: activado n: desactivadoNo
Por defecto: y
alwAdvierte de posibles alternativas a extranjerismos.y: activado n: desactivadoNo
Por defecto: n
wtcAvisa de confusiones frecuentes entre pares de términos.y: activado n: desactivadoNo
Por defecto: n
wpsAvisa de signos de porcentaje (%) no espaciados.y: activado n: desactivadoNo
Por defecto: n
psrAdvierte de posibles reducciones consonánticas ps-.y: activado n: desactivadoNo
Por defecto: n
nsrAdvierte de posibles reducciones consonánticas -ns-.y: activado n: desactivadoNo
Por defecto: n
bsrAdvierte de posibles reducciones consonánticas -bs-.y: activado n: desactivadoNo
Por defecto: n
strAdvierte de posibles reducciones consonánticas -st-.y: activado n: desactivadoNo
Por defecto: n
vrAdvierte de posibles reducciones vocálicas.y: activado n: desactivadoNo
Por defecto: n
sdmAdvierte de la posible eliminación de tilde diacrítica en «sólo».y: activado n: desactivadoNo
Por defecto: n
ddmAdvierte de la posible eliminación de tilde diacrítica en demostrativos.y: activado n: desactivadoNo
Por defecto: n
confCampo que indica la confianza mínima requerida en las sugerencias.Número entero desde 0 hasta 100No
Por defecto: 60

3.1 Diccionarios

IdiomaDiccionarios temáticosDiccionarios de variedadesPor defecto
Español
  • c: Ciencia y Tecnología
  • h: Humanidades
  • e: Economía
  • t: Ciencias Naturales
  • s: Ciencias Sociales
  • d: Deporte
  • p: Política
  • q: Lengua coloquial
  • r: Arcaísmos
  • S: SMS
  • 0: Español de Hispanoamérica
  • 1: Español de Hispanoamérica septentrional
  • 2: Español de Centroamérica
  • 3: Español de Hispanoamérica meridional
  • 4: Español del Caribe
  • M: Español de México
  • chetsdpqr

4 Respuesta

La respuesta contiene la información asociada al resultado de la petición. En la siguiente tabla se describen los campos que la conforman.

CampoDescripción
statusContiene información sobre el proceso de revisión y si ha concluido con éxito. Está formado por un código code, un número natural que identifica el resultado, y un mensaje o string que describe dicho resultado. Además, el campo credits indica el número de créditos consumidos en la petición y el campo remaining_credits el número de créditos que le quedan de saldo al usuario.

Los posibles códigos con sus respectivos mensajes se encuentran en la siguiente tabla:

codemessage
0OK
100Operation denied
101License expired
102Credits per subscription exceeded
103Request too large
104Request rate limit exceeded
200Missing required parameter(s) - [name of the parameter]
201Language not supported
202Engine internal error
203Cannot connect to service
El límite al que refiere el código 103 es de 50 000 palabras por petición...

Se considera una petición cualquier requerimiento HTTP a la API de menos de 500 palabras. Si el texto enviado es más largo, implicará un proceso de tantas peticiones como suponga la división del volumen total de palabras en bloques de 500. Por tanto, una petición HTTP de 1003 palabras contabilizaría como 3 peticiones, equivalente al consumo de 3 créditos; una petición HTTP de 25 648 se procesaría como 25 648/500 = 51 296 => 52 créditos; y así sucesivamente.
result_listDevuelve la lista de errores y recomendaciones que el sistema propone tras verificar la redacción del texto que incluye la petición. Contiene los siguientes campos:
textContexto que abarca el error
typeTipo de error lingüístico. Hay 5 tipos posibles:

codetype
SError o advertencia ortográfica
GError o advertencia gramatical
YError o advertencia de estilo
TError o advertencia de tipografía
MError o advertencia semántica
inipPosición inicial del resultado, comenzando por 0
endpPosición final del resultado
levelNivel MCER del error. MCER (Marco Común Europeo de Referencia para el aprendizaje de lenguas).
ruleId (nombre) de la regla que se ejecuta asociada al error.
msgMensaje explicativo correspondiente con el error detectado.
refReferencia bibliográfica asociada. Estas son las posibles:

RAE 2010:Ortografía de la lengua española (Real Academia Española, 2010).
RAE 2009:Nueva gramática de la lengua española (Real Academia Española, 2009).
DPD:Diccionario panhispánico de dudas. (Real Academia Española, 2005).
De_Sousa:Diccionario de usos y dudas del español actual (J. Martínez de Sousa, 2003). Ortografía y ortotipografía del español actual. (J. Martínez de Sousa, 2004).
Seco: Diccionario de dudas y dificultades de la lengua española. (M. Seco, 2002).
Fundéu: Recomendaciones y dudas [on line] (Fundéu BBVA).
El País: Libro de estilo EL PAÍS. (VV. AA., 2014).
sug_listLista de posibles sugerencias para corregir el problema. Cada sugerencia tendrá 2 campos:

formTexto de la sugerencia
confidenceNivel de confianza con que se ofrece la sugerencia.
stadisticsContiene un recuento cuantitativo de los siguientes valores:

wordsCantidad total de palabras
non-repeated_wordsCantidad de palabras no repetidas
characters_without_spacesCantidad de caracteres sin espacios
total_charactersCantidad total de caracteres
sentencesNúmero de frases
paragraphNúmero de párrafos

5 Ejemplo

Dado el siguiente texto:

No vengas hacernos creer que todos vemos los mismos reality shows en television.
					

La salida sería:

{
  "status": {
    "code": "0",
    "msg": "OK"
  },
  "result_list": [
    {
      "text": "vengas hacernos",
      "type": "G",
      "inip": "3",
      "endp": "17",
      "level": "B1",
      "rule": "ReglaVenir+INF",
      "msg": "Posiblemente sea necesario incluir la preposición a.",
      "sug_list": [
        {
          "form": "vengas a hacernos",
          "confidence": "70"
        }
      ]
    },
    {
      "text": "reality shows",
      "type": "T",
      "inip": "52",
      "endp": "64",
      "level": "A1",
      "rule": "ReglaRevisionPalabras-V",
      "msg": "Voz inglesa (debería ir en cursiva).",
      "ref": "Fundéu / El_País",
      "sug_list": [
        {
          "form": "programa de telerrealidad",
          "confidence": "99"
        },
        {
          "form": "telerrealidades",
          "confidence": "99"
        },
        {
          "form": "programa de sucesos",
          "confidence": "99"
        }
      ]
    },
    {
      "text": "television",
      "type": "S",
      "inip": "69",
      "endp": "78",
      "level": "A1",
      "rule": "ReglaRevisionPalabras-1",
      "msg": "Posible error ortográfico.",
      "sug_list": [
        {
          "form": "televisión",
          "confidence": "99"
        }
      ]
    }
  ],
  "statistics": {
    "words": "13",
    "non-repeated_words": "13",
    "characters_without_spaces": "68",
    "total_characters": "80",
    "sentences": "1",
    "paragraphs": "1"
  }
}
					

6 Usar la API

Si es suscriptor del servicio, vaya a la pestaña Mi Cuenta -> Estadísticas de uso y copie su clave de la tabla API. Demo no disponible para el resto de usuarios.







Configuración



MeaningCloud
© MeaningCloud. Todos los derechos reservados.
www.meaningcloud.com
Stilus
http://www.mystilus.com/img/logo.gif
Stilus es un corrector / revisor ortográfico, gramatical y de estilo multiidioma y accesible vía web o integrado en Microsoft Word
MeaningCloud