diff --git a/README.md b/README.md index f9752c7..26c25a1 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Estos datos son accesibles mediante una API REST. - Conteo de IoC válidos por cada organización conectada (diariamente). - Proceso de curación diario, esto quiere decir eliminar IoC dentro de MISP que sean falsos positivos. -### Requisitos +## Requisitos - Se requiere una cuenta en la plataforma Kaspersky© Threat Intelligence Portal. La cuenta es gratuita. ([https://opentip.kaspersky.com]) ## Componentes @@ -139,7 +139,7 @@ pip install --upgrade -r requirements.txt > /dev/null 2>&1 uvicorn main:app --host 0.0.0.0 --port 8000 ``` -### Agregar como servicio +## Agregar como servicio 1. Para agregar como servicio necesita crear dentro del directorio /etc/systemd/system (En caso de Ubuntu) un archivo .service (misptopcontrib.service). Podemos crearlo con nano (sudo) usando el siguiente formato: @@ -175,6 +175,20 @@ sudo systemctl stop misptopcontrib sudo systemctl restart misptopcontrib ``` + +## Servicios (Endpoints) de API + +- /api/stats/ --> Cantidad de contribuciones (IoC) de cada organización. +- /api/stats/cantidad_por_organizacion/ --> Cantidad total de contribuciones (IoC) de cada organización (Año). +- /api/stats/por_periodo/ --> Cantidad de contribuciones (IoC) de cada organización de un período específico. + +## Consulta de API + +- Se puede utilizar Chart.js para mostrar los datos consultados de manera más ordenada. + +- Ejemplo en producción: https://csirt.gob.cl/servicios/intercambio-de-indicadores-de-compromiso/estad%C3%ADsticas-de-colaboraci%C3%B3n-misp/ + + ## Ejecución El ideal es la recolección diaria de Ioc dentro de MISP. El archivo run_daily.py debe agendarlo de forma diaria para recolectar por dia (dia anterior completo)