Introducción

Objetivo

Autenticación

De forma predeterminada, todos los datos del Manualcatalogo

Elestán objetivofuera del Manualalcance de Usolos usuarios no autenticados. Para obtener acceso a los datos protegidos, debe solicitar un token de acceso.

Más sobre Autenticación en catalogo aqui.

REST API y los Datos relacionales

De forma predeterminada, Catalogo solo recupera el valor de referencia de un campo relacional en los elementos. Para recuperar también datos anidados de un campo relacional, se puede utilizar el parámetro fields en REST. Esto le permite recuperar datos referenciados de un servicio.

Para definir el ámbito de los campos que se devuelven por tipo de colección, puede usar la sintaxis <field>:<scope> del parámetro fields de la Plataformasiguiente manera:

GET /items/services
	?fields[]=name
	&fields[]=description
	&fields[]=legal_framework_ids.description
	&fields[]=services_electronic_gov_type_ids.electronic_gov_type_id.type

Otra alternativa seria:

GET /items/services
	?fields[]=name,description,legal_framework_ids.description,services_electronic_gov_type_ids.electronic_gov_type_id.type

Método HTTP SEARCH

Al usar la API de CatálogoREST para leer varios elementos mediante filtros (muy) avanzados, es posible que se encuentre con el problema de Serviciosque la dirección URL simplemente no puede contener suficientes datos para incluir la estructura de consulta completa. En esos casos, puede usar el método HTTP SEARCH como reemplazo directo de GET, donde se le permite colocar la consulta en el cuerpo de la solicitud de la siguiente manera:

Antes:

GET /items/services?filter[name][_eq]=Hello World

Después:

SEARCH /items/services

{
	"query": {
		"filter": {
			"name": {
				"_eq": "Hello World"
			}
		}
	}
}

Hay mucha discusión sobre si se debe o no poner un cuerpo en una solicitud GET, usar POST para crear consultas de búsqueda o confiar en un método completamente diferente. A partir de ahora, hemos optado por alinearnos con la especificación del método HTTP SEARCH de IETF.

Lectura útil:

Método de búsqueda HTTP (IETF, 2021) Definición de un nuevo método HTTP: HTTP SEARCH (Tim Perry, 2021) HTTP GET con cuerpo de solicitud (StackOverflow, 2009 y en curso) Uso del cuerpo de Elastic Search GET (elástico, s.f.) Dropbox comienza a usar POST y por qué se trata de un diseño deficiente de la API. (Evert Pot, 2015)

Códigos de error

A continuación, se muestran los códigos de error globales utilizados en Catalogo y lo que significan.

Código de error Estado Descripción FAILED VALIDATION 400 Error en la validación de este elemento en particular FORBIDDEN 403 No se le permite realizar la acción actual INVALID_TOKEN 403 El token proporcionado no es proporcionarválido a TOKEN_EXPIRED 401 El token proporcionado es válido pero ha caducado INVALID_CREDENTIALS 401 El nombre de usuario/contraseña o el token de acceso son incorrectos INVALID IP 401 Su dirección IP no está en la lista de permitidos para ser utilizada con este usuario INVALID_OTP 401 Se proporcionó una OTP incorrecta INVALID_PAYLOAD 400 La carga útil proporcionada no es válida INVALID_QUERY 400 No se pueden utilizar los usuariosparámetros unade guíaconsulta completasolicitados y detallada UNSUPPORTED_MEDIA_TYPE 415 El formato de carga útil o el encabezado proporcionados no son compatibles Content-Type REQUESTS_EXCEEDED 429 Alcanza el límite de velocidad ROUTE_NOT_FOUND 404 El punto de conexión no existe SERVICE_UNAVAILABLE 503 No se pudo usar el servicio externo UNPROCESSABLE_CONTENT 422 Intentaste hacer algo ilegal

Seguridad

Para evitar que lesse permitafiltren comprender,los utilizarelementos y administrar eficazmenteexistentes, todas las funciones y característicasacciones de la plataforma de catálogo de servicios. Este manual tiene como propósito principal:

Objetivos

Orientar a los Usuarios:elementos Proporcionarno unaexistentes introducción clara y accesible a la plataforma, explicando su propósito, funcionalidades y beneficios.

Facilitar la Navegación y Uso: Detallar los pasos y procedimientos necesarios para navegar por la plataforma, acceder a sus diferentes secciones y utilizar sus herramientas de manera eficiente.

Instruir en la Gestión de Servicios: Guiar a los usuarios sobre cómo agregar, modificar, categorizar y retirar servicios dentro del catálogo, resaltando las mejores prácticas para mantener actualizada y precisa la información.

Describir Procesos y Flujo de Trabajo: Explicar los procesos y flujos de trabajo para la gestión de solicitudes de cambio, desde su presentación hasta su aprobación, implementación y seguimiento.

Ofrecer Soporte y Recursos: Proporcionar respuestas a preguntas comunes, soluciones a problemas típicos, acceso a recursos adicionales, enlaces útiles y puntos de contacto para soporte técnico.

Asegurardevolverán un Usoerror Efectivo y Eficiente: Capacitar a los usuarios para utilizar la plataforma de manera efectiva, maximizando su utilidad y minimizando errores o malentendidos en su funcionamiento.FORBIDDEN.

MejorarPara la Colaboración y Comunicación: Facilitar la interacción entre usuarios al explicar cómo realizar comentarios, intercambiar información y colaborar en la gestión de servicios y cambios.

Servir como Referencia Centralizada: Constituir una referencia centralizada para todos los aspectos relacionados con la plataforma, desde el uso básico hasta los procedimientosconocer más avanzados y la gestión administrativa.

En resumen, el objetivo fundamental del Manual de Uso de la Plataforma de Catálogo de Servicios es ser una herramienta integral y comprensible que empodere a los usuarios para aprovechar al máximo las funcionalidades de la plataforma, permitiéndoles gestionar eficientemente los servicios y las solicitudes de cambios en el catálogo, y facilitando la colaboración y la comunicación en el contexto de la gestión de servicios.

Visión General de la Plataforma 

La Plataforma de Catálogo de Servicios es una herramienta integral diseñada para facilitar la gestión centralizada, la presentación y el acceso a una amplia gama de servicios ofrecidos por diversas entidades gubernamentales e instituciones.

Propósito Principal

La plataforma tiene como objetivo principal consolidar y ofrecer un catálogo unificado que reúna información detallada sobre los serviciositems, disponiblesconsultas paray filtrado en catalogo visita los ciudadanosenlaces y otras entidades gubernamentales, con el fin de:correspondientes.

Centralizar la Información: Agregar servicios de múltiples entidades en un único repositorio accesible.

Facilitar la Búsqueda y Acceso: Permitir a los usuarios buscar, encontrar y acceder fácilmente a la información sobre servicios disponibles.

Mejorar la Transparencia: Brindar transparencia al público sobre los servicios gubernamentales ofrecidos y sus detalles específicos.

Optimizar la Gestión de Servicios: Permitir a los administradores gestionar de manera eficiente los servicios, su actualización y seguimiento de solicitudes de cambio.

Funcionalidades Clave

Catálogo Unificado de Servicios: Una base de datos centralizada que alberga una amplia gama de servicios ofrecidos por múltiples instituciones gubernamentales.

Navegación y Búsqueda Intuitiva: Una interfaz amigable que permite a los usuarios buscar servicios por categoría, palabras clave o filtros específicos para encontrar información detallada sobre cada servicio.

Gestión de Solicitudes de Cambio: Una función que facilita la presentación, revisión, aprobación y seguimiento de solicitudes de cambio en los servicios publicados.

Colaboración y Comunicación Eficiente: Herramientas que permiten a los usuarios realizar comentarios, interactuar y colaborar en la mejora continua de los servicios.

Informes y Analíticas: Capacidad para generar informes detallados y obtener métricas para evaluar el rendimiento y la utilización de los servicios.

Beneficios para los Usuarios

Acceso Consolidado: Acceso rápido y centralizado a información detallada sobre los servicios gubernamentales disponibles.

Transparencia y Claridad: Claridad de los detalles de los servicios ofrecidos.

Facilidad de Gestión: Herramientas eficientes para la administración y mejora continua de los servicios.

Colaboración y Participación: Facilitación de la interacción entre usuarios para compartir comentarios y sugerencias sobre los servicios.

Audiencia Objetivo

Administradores y Gestores de la Plataforma:

Responsables de TI: Personal encargado de administrar y mantener la plataforma desde el punto de vista técnico.

Administradores de Servicios: Individuos encargados de agregar, editar y retirar servicios del catálogo, así como gestionar las solicitudes de cambio.

Usuarios Internos de las Instituciones Gubernamentales:

Funcionarios y Personal Gubernamental: Personas que requieren acceder y utilizar la plataforma para encontrar información sobre los servicios ofrecidos por sus instituciones.

Equipos de Soporte y Capacitación:

Personal de Capacitación: Aquellos encargados de entrenar a los usuarios sobre cómo utilizar la plataforma de manera eficaz.

Equipo de Soporte Técnico: Personas responsables de brindar asistencia técnica y resolver problemas relacionados con la plataforma.

Decision-makers y Directivos:

Directivos y Líderes: Personas que toman decisiones estratégicas y necesitan comprender cómo la plataforma contribuye a los objetivos organizacionales más amplios.

Otros Usuarios Específicos:

Analistas de Datos: Usuarios que podrían utilizar la plataforma para obtener datos y métricas para análisis posteriores.

Desarrolladores: Aquellos interesados en integrar la plataforma o trabajar en su desarrollo y mejora continua.