Referencia del manifiesto de la aplicación

El manifiesto de la aplicación (manifest.json) define las propiedades de una aplicación y sus ubicaciones de integración con Flowlu. Describe cómo se identifica la aplicación, qué permisos solicita y dónde se integra en la interfaz.

{
  "appId": "com.example.weather",             // Identificador único de la aplicación
  "name": "Pronóstico del Tiempo",           // Nombre de la aplicación
  "version": "1.0.0",                        // Versión de la aplicación (Mayor.Menor.Parche)
  "description": "Muestra el clima en la ciudad seleccionada.",
  "author": {
    "name": "Example Inc.", 
    "contact": "[email protected]"
  },
  "iconUrl": "https://example.com/icon.png",  // URL del icono de la aplicación
  "categories": ["Utilidades"],              // Categorías/secciones del Marketplace
  "tags": ["clima", "pronóstico"],
  "permissions": [                           // Derechos de acceso solicitados
    "crm.contacts.read", 
    "tasks.create"
  ],
  "integrationPoints": {                     // Puntos de integración de la aplicación:
    "menu": {                                // -> elemento en el menú principal
      "section": "CRM", 
      "title": "Pronóstico del Tiempo",
      "icon": "https://example.com/menu_icon.png"
    },
    "dashboard": {                           // -> widget en el escritorio (dashboard)
      "widgetTitle": "Clima hoy",
      "size": "small"
    },
    "cards": [                               // -> widget en tarjetas de objeto (ej. cliente)
      {
        "entity": "client", 
        "widgetTitle": "Clima en la región del cliente"
      }
    ]
  },
  "entrypointURL": "https://app.example.com/",   // URL de la interfaz web principal de la aplicación
  "webhookURL": "https://app.example.com/webhook", // (opcional) URL para callbacks
  "apiEndpoints": {                             // (opc.) métodos de API adicionales de la aplicación
    "getForecast": {
      "url": "https://app.example.com/api/forecast",
      "method": "GET"
    }
  },
  "configuration": {                            // (opc.) esquema de configuración de la aplicación
    "configSchema": {
      "type": "object",
      "properties": {
        "apiKey": { "type": "string", "title": "Clave API del servicio meteorológico" }
      },
      "required": ["apiKey"]
    },
    "defaultConfig": {
      "apiKey": ""
    }
  },
  "platformVersion": "1.0"                     // Versión compatible de la plataforma Flowlu
}

Campos clave del manifiesto de la aplicación

Identificación de la aplicación

Los campos appId, name y version identifican la aplicación.

• appId es un identificador único o espacio de nombres, utilizado internamente y en referencias como la URL de la aplicación.
• version sigue el versionado semántico (SemVer) y se utiliza para rastrear actualizaciones.

Descripción y metadatos

• description es un breve resumen de lo que hace la aplicación.
• categories y tags clasifican la aplicación en el catálogo del Marketplace.
• author contiene el nombre del desarrollador o empresa y los datos de contacto.

Icono y activos visuales

El campo iconUrl apunta al icono de la aplicación (PNG o SVG), que se muestra en el Marketplace y en cualquier ubicación de integración donde la aplicación esté integrada en la interfaz. Se pueden definir activos visuales adicionales, como capturas de pantalla o vistas previas, para el catálogo.

Permisos

El campo permissions enumera los derechos de acceso que solicita la aplicación, indicando qué módulos o datos de Flowlu necesita, como leer contactos de CRM o crear tareas.

Un administrador aprueba cada permiso solicitado durante la instalación, y la aplicación se instala solo si se confirman todos. En tiempo de ejecución, Flowlu aplica estos permisos estrictamente: cualquier solicitud de API fuera del alcance aprobado se rechaza automáticamente.

Ubicaciones de integración

La sección integrationPoints define dónde aparece la aplicación en la interfaz de Flowlu. Cada ubicación se configura como una sección separada en el manifiesto de la aplicación. Los más comunes incluyen:

• header: la barra de navegación superior.
• menu: el menú de navegación principal.
• tabs: una pestaña en las páginas de entidad, como una oportunidad de venta o una tarea.
• cards: un widget dentro de una tarjeta de entidad, como un perfil de cliente.

Otros puntos admitidos incluyen reports (tipos de informes personalizados), dashboard (widgets de dashboard), mobile (integraciones de aplicaciones móviles) y contactCenter (integración del módulo de comunicaciones). La lista completa está en Ubicaciones de integración admitidas.

URLs de servicios externos

Para las aplicaciones que dependen de un servicio web externo, el manifiesto de la aplicación puede incluir:

• entrypointURL: la URL principal de la interfaz de la aplicación, cargada en un iframe embebido o en una pestaña separada.
• webhookURL: una URL opcional a la que la plataforma envía eventos, como notificaciones de instalación y desinstalación, y eventos de CRM.
• apiEndpoints: un conjunto opcional de métodos de API adicionales que la propia aplicación proporciona. Flowlu puede llamarlos cuando sea necesario, por ejemplo, para recuperar datos de la aplicación.

Ajustes de configuración

La sección configuration se utiliza cuando una aplicación necesita ajustes definidos por el usuario al momento de la instalación.

• configSchema es un JSON Schema que describe los parámetros esperados. Flowlu lo utiliza para generar automáticamente un formulario de configuración durante la instalación.
• defaultConfig establece valores predeterminados para esos parámetros.

Esto permite que una aplicación solicite los datos que necesita (como una clave de API para un servicio externo) y los almacene de forma segura.

Validación del manifiesto de la aplicación

Mantenga el manifiesto de la aplicación pequeño y fácil de procesar para la plataforma. Cuando se carga una aplicación, Flowlu valida el manifiesto de la aplicación contra el esquema JSON actual y rechaza la instalación o publicación si falta un campo obligatorio o si tiene un formato incorrecto. Siga el esquema del manifiesto de la aplicación en la documentación y valídelo mientras desarrolla.