En este artículo, se explica cómo registrar una aplicación y publicarla en el mercado de aplicaciones de la plataforma. Este artículo asume que se está desarrollando una aplicación que será capaz de interactuar con la API de la plataforma.
Contenidos
Introducción
La plataforma EM tiene un market de aplicaciones que permite al usuario instalar aplicaciones para ampliar las funcionalidades de la plataforma utilizando la API abierta de la plataforma. Puedes encontrar más información sobre la API here.
Requisitos
Necesitarás un usuario superAdmin para registrar una aplicación para tu cuenta. Necesitarás las URL de tu aplicación para la instalación, y cualquier vista y/o informe que la aplicación genere.
¿Cómo funciona?
Accede al menú "Gestionar cuentas", haciendo clic en el botón con tu inicial en la esquina superior derecha de la pantalla de la plataforma.
Una vez en el menú de Gestionar cuentas, hazclic en "Aplicaciones del Market":
Presiona el botón "Nueva Market App" para registrar una nueva aplicación. El formulario de registro de la aplicación aparecerá con las siguientes áreas:
- Información general
- Precios (No se usa)
- URLs
- Informes
- Permisos
Información General
Puedes introducir la información general de la aplicación, como:
- Nombre: el nombre de la aplicación
- Descripción: Una breve descripción. Permite un simple formateo html, imágenes y gifs.
- Imagen: El icono de la aplicación que aparecerá en el market de aplicaciones
- Contacto: información de contacto (como una dirección de correo electrónico)
- Software por: quién desarrolló la aplicación
- Visibilidad: Elige la visibilidad de la aplicación en la plataforma:
- Privado: la aplicación sólo estará disponible para tu organización y clientes.
- Público: la aplicación estará disponible para cualquier usuario de la plataforma (fuera de de tu propia organización y clientes)
URLs
Estas son las principales URL a las que la plataforma accederá cuando necesite interactuar con la aplicación, durante la configuración o cuando el usuario accede a la aplicación. Deberían apuntar a los endpoints correspondientes de la aplicación. Para este ejemplo se asume que la aplicación está alojada en el dominio app.domain.com.
- Términos de servicio: Opcionales. Puedes listar un sitio con los términos del servicio que debe ser revisado y aceptado por el usuario antes de usar la aplicación
- Instalar: Requerido. La dirección listada aquí será consultada cuando se instale la aplicación por un usuario en una cuenta. Tus desarrolladores pueden aprender más sobre el proceso de instalación de la aplicación aquí.
- Desinstalación: Opcional. Este endpoint será consultado cuando se desinstale la aplicación.
- Vistas: Opcional. Las vistas de la aplicación que serán accesibles desde la plataforma y en qué parte de la interfaz estarán disponibles. Dependiendo del tipo de aplicación que se está desarrollando, querrás indicar diferentes pantallas. Necesitarás lo siguiente para cada pantalla:
- Nombre de la vista
- URL que la plataforma consultará para mostrar esa vista al usuario
- La pantalla en la que se mostrará.
Si la aplicación sólo crea informes, las vistas pueden dejarse vacías.
Puedes añadir varias vistas para una aplicación determinada.
Los ejemplos para estos podrían ser los siguientes:
Informes
Si la aplicación crea informes, tendrán que ser listados en esta sección. El informe de la aplicación será accesible en la sección de informes de la plataforma, y la plantilla asociada será seleccionable cuando se crea un nuevo informe.
Al registrar la aplicación, deberás informar lo siguiente:
- Nombre: El nombre de la plantilla del informe
- Imagen: Una imagen para el informe (opcional)
- URLs: 3 URLs diferentes tienen que ser especificados aquí:
- Formulario de creación de informe
- Formulario de edición de informe
- URL de la aplicación de informes
Puedes añadir varios informes para una aplicación determinada.
Permisos
Determine qué partes de la cuenta serán accesibles para la aplicación en modo lectura y/o escritura. Por ejemplo, si la aplicación necesita acceso a datos de Lecturas pero el permiso correspondiente no se ha configurado, la aplicación no podrá acceder a los datos.
Una vez que se haya configurado todo, pulsa el botón de guardar y tu aplicación aparecerá en la lista de aplicaciones en la sección Market Apps dentro de Gestionar cuentas.
El App id y el App secret son hashes de la aplicación (borrosos en la imagen) deben ser almacenados en la aplicación, ya que se necesitarán cada vez que la aplicación se instale en una de sus cuentas. Tus desarrolladores pueden aprender más sobre el proceso de instalación de la aplicación y cómo se utilizan estos hashes aquí.
La aplicación estará disponible para probar, ya que aparecerá en el mercado para tus cuentas. Una vez que estés listo para compartir la aplicación con tus usuarios, puedes publicarla.
Publicar la aplicación
En la lista de aplicaciones del market, haz clic en "Seleccionar una acción" y pulse "Publicar" para publicar tu aplicación. La solicitud de publicación tendrá que ser aprobada por el equipo de soporte de la plataforma EM. Su estado permanecerá pendiente hasta que la solicitud haya sido procesada.