Stilus API
Integre Stilus en cualquier entorno de edición
2 Punto de entrada
3 Petición
3.1 Diccionarios
4 Respuesta
5 Ejemplo
6 Usar la API
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. 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.
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ámetro | Descripción | Valores | Requerido |
---|---|---|---|
key | Token de autorización para realizar peticiones a la API. Se puede obtener una clave válida gratuita creando una cuenta en MeaningCloud | String | Sí |
txt | Texto que se desea procesar | String | Sí |
url | URL 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í. | String | No |
ilang | Especifica 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 |
mode | Determina 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 |
version | Versión de la API | String | No |
if | Formato de la entrada | String | No Por defecto: html |
of | Formato de la salida | xml, json | No Por defecto: json |
offset | El 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 |
dic | Especifica 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 |
pp | Detección inteligente de palabras prefijadas. | y: activado n: desactivado | No Por defecto: y |
aqoi | Manejo inteligente de palabras escritas en cursiva o entre comillas. | y: activado n: desactivado | No Por defecto: y |
tls | Aviso sobre frases demasiado largas. | y: activado n: desactivado | No Por defecto: y |
dpn | Detección inteligente de nombres propios. | y: activado n: desactivado | No Por defecto: n |
stme | Determina el comportamiento ante frases con varios errores. | 0: Comprobar todas 1: Agrupar e ignorar 2: Agrupar y advertir | No Por defecto: 2 |
red | Localiza tautologías y uso excesivo de preposiciones o conjunciones. | y: activado n: desactivado | No Por defecto: y |
spa | Comprueba el espaciado. | y: activado n: desactivado | No Por defecto: y |
comppunc | Verifica la apertura y el cierre de los pares de signos. | y: activado n: desactivado | No Por defecto: y |
corrpunc | Verifica el uso de los signos de puntuación. | y: activado n: desactivado | No Por defecto: y |
alw | Advierte de posibles alternativas a extranjerismos. | y: activado n: desactivado | No Por defecto: n |
wct | Avisa de confusiones frecuentes entre pares de términos. | y: activado n: desactivado | No Por defecto: n |
wps | Avisa de signos de porcentaje (%) no espaciados. | y: activado n: desactivado | No Por defecto: n |
psr | Advierte de posibles reducciones consonánticas ps-. | y: activado n: desactivado | No Por defecto: n |
nsr | Advierte de posibles reducciones consonánticas -ns-. | y: activado n: desactivado | No Por defecto: n |
bsr | Advierte de posibles reducciones consonánticas -bs-. | y: activado n: desactivado | No Por defecto: n |
str | Advierte de posibles reducciones consonánticas -st-. | y: activado n: desactivado | No Por defecto: n |
vr | Advierte de posibles reducciones vocálicas. | y: activado n: desactivado | No Por defecto: n |
sdm | Advierte de la posible eliminación de tilde diacrítica en «sólo». | y: activado n: desactivado | No Por defecto: n |
ddm | Advierte de la posible eliminación de tilde diacrítica en demostrativos. | y: activado n: desactivado | No Por defecto: n |
conf | Campo que indica la confianza mínima requerida en las sugerencias. | Número entero desde 0 hasta 100 | No Por defecto: 60 |
3.1 Diccionarios
Idioma | Diccionarios temáticos | Diccionarios de variedades | Por defecto |
---|---|---|---|
Español |
|
|
|
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.
Campo | Descripción | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
status | Contiene información sobre el proceso de revisión y si ha concluido correctamente. 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:
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_list | Devuelve 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:
| ||||||||||||||||||||||||||||||||||||||||||||||||
stadistics | Contiene un recuento cuantitativo de los siguientes valores:
|
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
Ya puede utilizar de forma gratuita el corrector de ortografía y gramática más valorado.