Introducción a la API de DataInt

La arquitectura de nuestra plataforma está basada en un enfoque de microservicios, lo que significa que cada componente funcional del sistema opera de manera independiente y expone su propia API. Esta estructura permite una mayor escalabilidad, mantenibilidad y flexibilidad a la hora de integrar nuevos servicios o realizar ajustes a componentes existentes.

Entre los microservicios más importantes se encuentra el servicio de autenticación, responsable de la gestión de:

• Organizaciones y estructuras jerárquicas
• Cuentas de usuario
• Permisos y roles
• Autenticación por contraseña

Este microservicio actúa como eje central de control de acceso para toda la plataforma. Cada una de las demás APIs consulta los recursos del servicio de autenticación para validar los derechos de acceso de los usuarios y garantizar una operación segura y coherente entre servicios.

Actualmente, la plataforma cuenta con los siguientes microservicios disponibles:

• Catálogos: expone endpoints para consultar catálogos de delitos, estados, municipios, entre otros elementos de referencia utilizados por los demás servicios de la plataforma.
• Incidencia delictiva: permite consultar datos publicados por el SESNSP, así como indicadores derivados, como niveles y tendencias de riesgo.
• Percepción de seguridad: permite consultar los resultados de la Encuesta Nacional de Seguridad Urbana (ENSU), publicada por el INEGI.
• OSINT: permite consultar eventos disruptivos detectados en fuentes abiertas, acceder a noticias monitoreadas por nuestro sistema de recolección, y gestionar los assets registrados por los usuarios.
• Reportes: permite generar documentos en formato Word que integran información de incidencia delictiva u OSINT, listos para compartirse o imprimirse.

Gracias a este diseño modular, las aplicaciones cliente (como nuestra interfaz web o integraciones de terceros) pueden interactuar con los distintos servicios de manera transparente, utilizando tokens de acceso que permiten autenticarse y consultar o modificar recursos según los permisos establecidos.

Contenido de esta documentación

Esta guía está organizada en secciones temáticas para facilitar la comprensión y el uso de nuestras APIs:

1. Antes de iniciar: requisitos previos y herramientas útiles
   Qué necesitas saber, tener y configurar antes de comenzar a consumir nuestras APIs. Incluye herramientas recomendadas como Postman o curl.

2. Glosario
   Definición de términos clave utilizados en la plataforma y la documentación (por ejemplo: asset, evento disruptivo, token, endpoint).

3. Uso de entornos de desarrollo y producción Indicaciones sobre cómo utilizar las APIs en entornos separados, incluyendo dominios, límites y buenas prácticas.

4. Flujo de autenticación
   Explicación del proceso de autenticación y obtención de tokens de acceso para consumir las APIs.

5. Servicio de autenticación
   Descripción detallada del microservicio de autenticación, incluyendo endpoints para gestión de organizaciones, usuarios, permisos y roles.

6. Servicio de catálogos
   Documentación completa del servicio de catálogos, incluyendo endpoints para consultar catálogos de ubicaciones, población, crímenes e indicadores ENSU.

7. Servicio de incidencia delictiva
   Descripción de los endpoints disponibles, parámetros, ejemplos de uso y estructura de respuesta.

8. Servicio de percepción de la seguridad
   Detalle sobre las consultas posibles a los datos de la ENSU y cómo interpretar los resultados.

9. Servicio de OSINT
   Guía para acceder a eventos disruptivos, noticias monitoreadas y administración de assets personalizados.

10. Servicio de reportes
    Instrucciones para generar documentos Word con información relevante y cómo personalizar su contenido.

11. Límites de uso y políticas de rate limiting
    Información sobre las restricciones aplicadas a las peticiones por usuario, por token o por IP, así como recomendaciones para evitar bloqueos.

Cada sección incluye ejemplos prácticos y respuestas esperadas para ayudarte a integrar rápidamente nuestras APIs en tus soluciones.