API REST

Uso de la API

Las solicitudes de la API se la hace mediante una petición a la URL_BASE de Servicios más la especificación del método deseado junto a los parámetros requeridos.

http://observatorioweb.ups.edu.ec

Métodos de Consulta

GET /oaw/srv/wcag/{formato}/conformidad

Información

Retorna el detalle de evaluación de accesibilidad de su página web, según el acierto o falla de las técnicas de verificación WCAG 2.0 asociadas y agrupadas acorde al conjunto de Principios, Pautas y Criterios de Cumplimiento definidos en la guía WCAG.

URL de solicitud

http://observatorioweb.ups.edu.ec/oaw/srv/wcag/{formato}/conformidad/?url={URL}&key={API_KEY}

Parámetros de entrada

Párametro Obligatoriedad Tipo Significado
formato SI Texto condicionado (xml/json) Formato de salida del texto de respuesta: XML o JSON. Posibles valores: xml o json.
url SI Texto, URL encoded URL de la página web a analizar.
key SI Texto, asociado a una cuenta activa API_KEY de usuario. La clave la puede obtener una vez registrado en el sitio.
nivel NO. (Por defecto AAA) Texto condicionado Nivel de conformidad sobre el que se quiere evalaur la página web. Solo se permiten valores como: A, AA y AAA.
resolucion NO. (Por defecto 1366x768) Texto condicionado Resolución del visor con el que se desea evaluar la página web, indicando ancho (width) y alto (height) en pixeles. Solo se permiten valores en el formato {width}x{height}. Ejemplo: 1366x668.

Parametros de salida

Párametro Tipo Descripción
fecha Fecha en uso horario GMT Fecha y hora en la que se realizo la solicitud.
mensaje Texto Mensaje de error en caso de no poder realizarse el análisis. Posibles fallos: Url incorrecta, formato incorrecto de parámetros, API_KEY incalido, etc.
resultado Grupo de datos Conjunto de datos parte del análisis propio de la página
resultado: {
	elementos: {...},
	imagen: "...",
	nivel: "...",
	principios: [],
	resolusion: "...",
	resumen: {...},
	url: "..."
}
		          	
resultado:elementos Grupo de datos Indicadores de número de elementos por tipo contenidos en la página:
  • formularios: Número de formularios contenidos en la página
  • iframes: Número de iframes contenidos en la página
  • imagenes: Número de imágenes contenidos en la página
  • links: Número de enlaces contenidos en la página
  • linksImagen: Número de enlaces con imagen contenidos en la página
  • tablas: Número de tablas contenidas en la página
  • total: Número de total de elementos contenidas en la página
resultado:imagen Texto Enlace a imagen correspondiente a un pantallazo de la página según resolución especificada
resultado:resolucion Texto Resolución con la que fue validad o verificada la página web solicitada
resultado:url URL URL de la pagian web evaluada

Ejemplo de código de respuesta

http://observatorioweb.ups.edu.ec/oaw/srv/wcag/json/conformidad/?url=http://dominio.com/mipagina.html&key=JSHS87DHDLSJS8SKSN9A

{
oaw: {
	fecha: "2015-09-07T22:03:02.741-05:00",
	resultado: {
		elementos: {
			formularios: 1,
			iframes: 0,
			imagenes: 43,
			links: 159,
			linksImagen: 34,
			objects: 0,
			tablas: 11,
			total: 770
		},
		imagen: "http://observatorio.ups.edu.ec/oaw/...",
		nivel: "AAA",
		principios: [
			{
				numero: 1,
				titulo: "Perceptible",
				descripcion: "La información y los ...",
				pautas: [
					{
						numero: "1.1.",
						descripcion: "Proporcionar alternativas textuales ...",
						titulo: "Alternativas textuales",
						criterioCumplimientos: {
						numero: "1.1.1.",
						nivel: "A",
						titulo: "Contenido no textual...",
						criterioExitos: [
							{
								codigo: "H24",
								criticidad: "Alta",
								titulo: "Proporcionar t...",
								incidencias: 16,
								exitos: 3,
								errores: 16,
								observacion: "De los 19 elementos...",
								recomendacion: "Se debe aplicar ...",
								clasificacion: "Error"
							},
							{
								codigo: "H35",
								criticidad: "Alta",
								titulo: "Proporcionando t...",
								incidencias: 0,
								exitos: 0,
								errores: 0,
								observacion: "Se recomienda colocar ...",
								recomendacion: "Todos los ap...",
								clasificacion: "Advertencia"
							},
							/* De más criterios que permiten verificar el criterio de cumplimiento*/
						]
					},
					/* De más pautas ...*/
				]
			},
			/* De más principios ...*/
		],
		resolucion: "1366x768",
		resumen: {
			comprensible: {
				advertencias: 5,
				errores: 3,
				exitos: 5,
				noaplica: 0
			},
			operable: {
				advertencias: 2,
				errores: 3,
				exitos: 4,
				noaplica: 3
			},
			perceptible: {
				advertencias: 17,
				errores: 11,
				exitos: 6,
				noaplica: 4
			},
			robusto: {
				advertencias: 2,
				errores: 1,
				exitos: 1,
				noaplica: 0
			},
			totalComprensible: "76%",
			totalOperable: "66%",
			totalPerceptible: "67%",
			totalRobusto: "75%"
		},
		url: "http://dominio.com/mipagina.html"
	}
	}
}
        	
        	

GET /oaw/srv/wcag/{formato}/tecnicas

Información

Retorna un detalle de la verificación de las técnicas WCAG 2.0 para evaluación de accesibilidad de su página web, agrupadas según los criterios de exito hasta ahora implementados.

URL de solicitud

http://observatorioweb.ups.edu.ec/oaw/srv/wcag/{formato}/tecnicas/?url={URL}&key={API_KEY}

Parámetros de entrada

Párametro Obligatoriedad Tipo Significado
formato SI Texto condicionado (xml/json) Formato de salida del texto de respuesta: XML o JSON. Posibles valores: xml o json.
url SI Texto, URL encoded URL de la página web a analizar.
key SI Texto, asociado a una cuenta activa API_KEY de usuario. La clave la puede obtener una vez registrado en el sitio.
resolucion NO. (Por defecto 1366x768) Texto condicionado Resolución del visor con el que se desea evaluar la página web, indicando ancho (width) y alto (height) en pixeles. Solo se permiten valores en el formato {width}x{height}. Ejemplo: 1366x668.

Parámetros de salida

Párametro Tipo Descripción
fecha Fecha en uso horario GMT Fecha y hora en la que se realizo la solicitud.
mensaje Texto Mensaje de error en caso de no poder realizarse el análisis. Posibles fallos: Url incorrecta, formato incorrecto de parámetros, API_KEY incalido, etc.
resultado Grupo de datos Conjunto de datos parte del análisis propio de la página
resultado: {
	criterios_exito: [...]
	elementos: {...},
	imagen: "...",	
	resolusion: "...",
	url: "..."
}
resultado:criterios_exito Colección de objetos Conjunto de criterios de exito con los datos obteniudos de la verificación automática de cada criterio, con los siguientes datos:
{
	codigo: "G11A",
	exitos: 770,
	errores: 0,
	observacion: "No se ha hecho uso de la etiqueta blink",
	recomendacion: "El uso de elementos que están en constante movimiento en la página no es recomendable",
	clasificacion: "Exito"
}

  • codigo: Código de identificación de criterio de exito o técnica de verificación.
  • exitos: Número de elementos evaluados que cumplen satisfactoriamente el criterio evaluado
  • errores: Número de elementos que fallan en la verificación de cumplimiento de cada criterio
  • observacion: Mensaje de información relacionado a la validación o verificación del criterio
  • recomendacion: Mensaje de recomentadión a tener en cuenta para superar el criterio, generalemten usado cuando se requiere el apoyo de verificación manual.
  • clasificacion: Tipo de clasificación con la que se ha evaluado al criterio. Posibles valores: Exito, Error, Advertencia, No Aplica (en el caso de no contener el elemento a evaluar según criterio)
resultado:elementos Grupo de datos Indicadores de número de elementos por tipo contenidos en la página:
elementos: {
	formularios: 1,
	iframes: 0,
	imagenes: 43,
	links: 159,
	linksImagen: 34,
	objects: 0,
	tablas: 11,
	total: 770
}
  • formularios: Número de formularios contenidos en la página
  • iframes: Número de iframes contenidos en la página
  • imagenes: Número de imágenes contenidos en la página
  • links: Número de enlaces contenidos en la página
  • linksImagen: Número de enlaces con imagen contenidos en la página
  • tablas: Número de tablas contenidas en la página
  • total: Número de total de elementos contenidas en la página
resultado:imagen Texto Enlace a imagen correspondiente a un pantallazo de la página según resolución especificada
resultado:resolucion Texto Resolución con la que fue validad o verificada la página web solicitada
resultado:url URL URL de la pagian web evaluada

Ejemplo de código de respuesta

http://observatorioweb.ups.edu.ec/oaw/srv/wcag/json/tecnicas/?url=http://dominio.com/mipagina.html&key=JSHS87DHDLSJS8SKSN9A

{
oaw: {
	fecha: "2015-09-08T00:25:53.077-05:00",
	resultado: {
		criterios_exito: [
			{
				codigo: "G11A",
				incidencias: 0,
				exitos: 770,
				errores: 0,
				observacion: "El uso de elementos que están ...",
				recomendacion: "No se ha hecho uso de la etiqueta blink",
				clasificacion: "Exito"
			},
			{
				codigo: "H2C",
				incidencias: 0,
				exitos: 157,
				errores: 2,
				observacion: "No es recomendable utilizar enlaces en ...",
				recomendacion: "De los 159 enlaces que hay en la página...",
				clasificacion: "Error"
			},
			{...}  /* De más criterios de exito analizados */
		],
		elementos: {
			formularios: 1,
			iframes: 0,
			imagenes: 43,
			links: 159,
			linksImagen: 34,
			objects: 0,
			tablas: 11,
			total: 770
		},
		imagen: "http://observatorioweb.ups.edu.ec/oaw/renderimagen?codigo=18b61...",
		resolucion: "1366x768",
		url: "http://dominio.com/mipagina.html"
	}
   }
}