directus-interoperability-plugin

Directus Interoperability Plugin

Descripción

El Directus Interoperability Plugin es una extensión diseñada para integrar directamente la plataforma de interoperabilidad gubernamental X-Road y/o cualquier otra API dentro de Directus. Esta extensión permite automatizar las llamadas a distintas APIs para rellenar automáticamente información en formularios o campos de distintas colecciones en el sistema Directus.

Funcionalidades Principales

1. Integración con X-Road:

   • Vincula Directus con la plataforma de interoperabilidad gubernamental X-Road.
   • Facilita la conexión segura y eficiente para intercambio de datos.

2. Soporte para Otras APIs:

   • Permite la conexión con cualquier otra API, proporcionando flexibilidad en la interoperabilidad con diversos servicios externos.

3. Automatización de Llamadas a API:

   • Permite automatizar las llamadas a las APIs vinculadas para recuperar y actualizar datos.

4. Rellenado Automático de Formularios:

   • Facilita la automatización del rellenado de información en formularios de Directus mediante la obtención de datos desde las APIs conectadas.

5. Configuración Flexible:

   • Proporciona una interfaz fácil de usar para configurar y gestionar las conexiones con diferentes APIs.

Instalación

I. Requisitos Previos:

• Asegúrese de tener una instalación funcional de Directus.
• Verifique los permisos necesarios para realizar llamadas a APIs externas.

II. Instalación en Directus:

• Abra una terminal en la carpeta de su proyecto Directus.
• Ejecute el siguiente comando para instalar el plugin desde npm:

  npm install @ogticrd/directus-interoperability-plugin
  

III. Guía de uso:

• Configuración de la extensión:

  Para configurar la extensión correctamente, deben seguirse los siguientes pasos:

  1 - Para utilizar la extensión, primero diríjase al apartado de creación o modificación de una colección en el panel administrativo de Directus.

  2 - Seleccione la opción crear campo en el formulario de creación o edición de la colección.

  3 - En el selector del tipo de campo, vaya a la sección de otros, seleccione la opción Interoperability y establezca un nombre o clave para su nuevo campo.

  4 - En las opciones del campo, deberá colocar detalles como la URL de la API a la que se harán las llamadas, así como su respectivo método GET, POST, PUT o DELETE. También podrá agregar ciertos parámetros adicionales como Headers y Query Parameters a la petición.

  

  Nota: Al rellenar estos campos puede utilizar la sintaxis de doble llaves {{ ... }} de Handlebars para hacer referencia a algún campo del formulario. Por ejemplo, la URL podría ser https://servicio.dominio.com/api/info/{{codigo}}. Esto permitirá computar la información existente de estos campos del formulario para alimentar la llamada a la API. Lo mismo aplica para los demás parámetros como Headers y Query Parameters.

  5 - Por último, se deben mapear los campos de la respuesta con los del formulario. Por ejemplo, dada la siguiente estructura como respuesta de la petición:

   {
     "data": {
       "id": "abcd1234",
       "name": "Leanne Graham",
       "username": "Bret",
       "phone": "1-770-736-8031 x56442",
       "photo": "https://via.placeholder.com/150/92c952"
     }
   }
  

  Si usted quiere mapear los campos name y photo de la respuesta con los campos nombre y photo respectivamente de su formulario, se puede lograr escribiendo lo siguiente en el campo Mapping de la configuracion.

  nombre -> data.name;
  foto -> data.photo;
  

  Con esto podra asegurarse de que a la hora de agregar un nuevo registro a su coleccion los campos nombre y foto seran mapeados y rellenados automaticamente.

Contribuciones

¡Las contribuciones son bienvenidas! Si encuentra problemas o tiene ideas para mejorar el plugin, no dude en abrir los issues o enviar solicitudes de merge en el repositorio oficial.

Licencia

Este plugin se distribuye bajo la Licencia MIT. Consulte el archivo LICENSE para obtener más detalles.