API para integración con Pirani

Ahora en Pirani por medio de integración por API podrás reportar los eventos y los registros transaccionales de AML que tengas en otros sistemas de registros.

Ahora en Pirani contamos con la integración por API, funcionalidad que te facilitará el importe de registros desde otros sistemas de reporteria de eventos y de inscripción de registros transaccionales. 

API para eventos: Adicional a los dos métodos de registro de eventos disponibles, el interno y el externo, ahora con la integración por API podrás crear eventos que tengas en otros sistemas y registrarlos en el módulo de eventos de Pirani. Además podrás asignar los roles que pueden acceder a la funcionalidad.

→ Funcionalidad disponible para los sistemas de gestión (ORM, ISMS y Compliance) en el plan Enterprise. 

API para AML: Con la integración para AML (Antilavado de dinero) podrás crear y actualizar desde otros sistemas de inscripción los registros transaccionales, es decir los clientes, productos y transacciones que tengas registrados en tus sistemas actuales.

→ Funcionalidad disponible para AML y solo en el plan Enterprise. 

¿Cómo realizar la integración por API?

Para realizar la integración con el software de Pirani debes dar clic en la parte superior izquierda, en los puntos que se encuentran al lado del logo de Pirani, ahí se desplegará un recuadro en el cual debes dar clic en la sección “Administrar organización”.

Al lado derecho encontrarás varias opciones para gestionar tu organización, ahora debes dar clic en la opción “ajustes del sistema”

⚡ En esta sección podrá encontrar toda la información técnica para integrar el API:

Aplicaciones privadas

En la sección de “Aplicaciones privadas”, encontrarás toda la información necesaria para integrar el API de manera eficiente. Se han implementado mejoras en la administración de la integración en línea y en la gestión de las API Key, lo que facilita a las organizaciones establecer nuevas conexiones con sistemas y servicios externos.

Seleccionaremos “Crear aplicación privada”.

Podrás crear una “Aplicación privada genérica”, donde definirás el tipo de aplicación y gestionar las conexiones a eventos, clientes, contrapartes, productos y transacciones. Esto te permitirá crear conexiones desde la API independientes para eventos, clientes, contrapartes, productos y transacciones.

En la opción de “Aplicación analítica”, podrás realizar consultas masivas sobre la información registrada en Pirani, y analizarla utilizando la herramienta de tu preferencia dentro de la organización.

Esta opción es crucial porque facilita la gestión de conexiones con aplicaciones externas dentro del ecosistema de la organización, mejorando el control, la seguridad y la escalabilidad de las integraciones.

Además, podrás generar una API Key para cada conexión que crees, así como gestionar aplicaciones genéricas y consultar los permisos de los módulos del sistema.

Configuración genérica: cómo configurar el API Key

Si necesitas configurar un API Key para integrar tu sistema, sigue este sencillo paso a paso:

1. Copia la URL del API Key que se genera en el sistema.
   
   
   
2. Configura el API Key en la plataforma o sistema que estés utilizando, pegando la URL en el campo correspondiente. Este proceso es clave para establecer una conexión segura entre tu sistema y otras aplicaciones, permitiendo el acceso a los datos de manera eficiente.
   

Configuración en Power BI: conexión

En esta sección, te mostraremos un resumen del paso a paso para realizar la conexión con Power BI.

Permisos con API Key

En cuanto a los permisos, podrás asignar acceso a diferentes áreas y módulos, determinando qué información se puede consultar a través del API Key.

Con el API Key, se habilitarán las consultas únicamente sobre los módulos a los que el usuario tenga acceso.

 ¡Ojo! Si el usuario no tiene permisos para un módulo específico, no podrá consultar ni acceder a esa información, asegurando que los datos estén protegidos y accesibles solo para quienes tengan la autorización correspondiente.

Documentación

¿Cómo hacer la integración de la API KEY en eventos? 

En este link encontrarás  toda la información necesaria para crear un evento o integrar con AML.

Este recurso te permitirá entender el proceso completo y configurar los eventos de manera eficiente según tus necesidades.

Integración de Eventos a través de la API

La API de Pirani ahora permite la integración de campos dinámicos en la creación de eventos. Anteriormente, la API sólo admitía el envío de campos básicos, como: 

• Nombre del evento 
• Descripción 
• Indicador de si genera pérdidas 
• Lugar donde ocurrió 
• Fecha de inicio 
• Fecha de descubrimiento 

Los clientes pueden enviar campos adicionales personalizados desde su aplicación externa o Pirani, permitiendo integrar toda la información relevante sin restricciones a los campos básicos.

¿Para qué sistemas de gestión aplica esta actualización?

Esta mejora en la API está disponible para los siguientes sistemas de gestión:

ORM (Gestión de Riesgos Operativos)

Compliance (Cumplimiento)

ISMS (Gestión de Seguridad de la Información)

Nota: Esta funcionalidad no aplica para el sistema de AML.

¿Cómo hacer la integración de la API en eventos?

En el sección de información técnica dale clic en el botón de “métodos” ahora dale nuevamente clic en “crear evento”

Crea o verifica los campos dinámicos:

Asegúrate de que los campos dinámicos que deseas integrar estén creados. Por ejemplo, podrías tener campos como:

• Fecha de Finalización del Evento
• Descripción del Analista de Riesgos
• Impacto Económico

Si no existen, créalos asignándoles un nombre, tipo de dato (texto, número, fecha, etc.) y otras propiedades necesarias.

Preparación de la aplicación externa

En tu aplicación externa, debes asegurarte de que los datos que deseas enviar a Pirani estén correctamente estructurados. Esto incluye tanto los campos básicos como los campos dinámicos.

Configuración de la solicitud de creación de eventos

Asegúrate de que los nombres de los campos dinámicos coincidan exactamente con los configurados en Pirani.

Utiliza el método “Crear Evento de la API”.

Incluye los campos básicos y dinámicos en la solicitud. Por ejemplo, en formato JSON.

Recopila la información:

Asegúrate de que tu aplicación externa tenga acceso a los datos que deseas enviar, incluyendo:

Campos básicos (nombre, descripción, lugar, fechas, etc.).

Campos dinámicos (los que configuraste en Pirani).

Configuración de la API

Este paso debe ser realizado por el equipo técnico de tu organización, ya que implica trabajar con código y parámetros de la API.

Obtén acceso a la API

• Asegúrate de tener las credenciales y permisos necesarios para usar la API de Pirani.

Envía la solicitud

Utiliza el endpoint correspondiente de la API para enviar la solicitud. Asegúrate de que la solicitud incluya los encabezados (headers) necesarios, como el token de autenticación.

Validación y creación del evento

Una vez enviada la solicitud, Pirani procesará la información y realizará las siguientes acciones

Validación de datos

Pirani verificará que los campos básicos y dinámicos estén correctamente estructurados y que los nombres de los campos dinámicos coincidan con los configurados en la plataforma.

Si hay errores (por ejemplo, un campo dinámico no existe o tiene un formato incorrecto), la API devolverá un mensaje de error con detalles para su corrección.

Creación del evento

Si la información es válida, Pirani creará el evento y lo almacenará en la plataforma.

El evento aparecerá en la sección correspondiente (ORM, Compliance o ISMS) con todos los campos básicos y dinámicos integrados.

Verificación en Pirani

Después de enviar la información, es importante verificar que el evento se haya creado correctamente.

Accede a la sección de eventos:

• Dentro de Pirani, ve a la sección de eventos del sistema de gestión correspondiente.

• Busca el evento recién creado.

Revisa los campos

• Asegúrate de que todos los campos básicos y dinámicos se muestren correctamente.

• Verifica que la información enviada desde tu aplicación externa coincida con la mostrada en Pirani.