Espacio para desarrolladores: desarrollar extensión

La sección Desarrollar extensión en el espacio para desarrolladores le permite crear sus propias extensiones de eWidget. La extensión que usted crea puede instalarse desde Marketplace y ser utilizada por otros usuarios.

Zoho Marketplace

Zoho Marketplace es la plataforma en línea que ofrece extensiones y widgets que ayudan a los usuarios a mejorar el flujo de trabajo en varias aplicaciones. Los usuarios pueden instalar las extensiones desde Zoho Marketplace para aprovechar las funciones de salida de las aplicaciones de Zoho.

Además de las extensiones ya disponibles, los desarrolladores ahora pueden crear extensiones más completas para Zoho Mail. Estas extensiones pueden crearse para integrar las funciones de Zoho Mail con las características de las aplicaciones de terceros. Esto ayuda a los usuarios a crear extensiones que se adapten a los requisitos personalizados.

Una vez que haya creado la extensión, deberá enviarla para una revisión. Después de analizar la funcionalidad, su extensión se aprobará y se publicará en Zoho Marketplace, por lo que estará disponible para que todos los usuarios de Zoho la instalen y utilicen.

Desarrollar la extensión

Puede comenzar a desarrollar su extensión directamente desde la plataforma Zoho Sigma utilizando un manifiesto de complemento de Zoho Mail completado previamente. De manera alternativa, también puede utilizar la CLI de ZET para desarrollar su extensión y, a continuación, cargar el archivo a Zoho Sigma para enviarlo.

Crear una extensión en Zoho Sigma

Para comenzar, cree un espacio de trabajo para usted mismo en Zoho Sigma con los siguientes pasos:

1. Inicie sesión en Zoho Sigma
2. Ingrese el nombre de su espacio de trabajo
3. Haga clic en Crear espacio de trabajo

Una vez que haya creado su espacio de trabajo, haga clic en el botón Nueva extensión en la esquina superior derecha. Ingrese los detalles como el nombre y la descripción, y seleccione Zoho Mail en la sección Servicio. A continuación, haga clic en Guardar como borrador y siga las instrucciones detalladas que se proporcionan en esta página de ayuda para comenzar a crear su extensión en Sigma.

Crear una extensión con la CLI de ZET

La interfaz de línea de comandos (CLI) se utiliza para crear y empaquetar widgets. El comando Zet es la CLI que se utiliza para empaquetar widgets para Zoho Mail.

Requisitos previos

Si desea crear sus propios widgets para Zoho Mail, debe descargar Nodejs. Puede descargarlo desde aquí. (Las versiones inferiores a la 7 no son compatibles)

Puede comprobar el nodo ejecutando los siguientes comandos:

$ node -v comprueba la versión del nodo.
$ npm -v comprueba la versión de npm.

Instalación

Instale la CLI de ZET (kit de extensión de Zoho) con el comando de a continuación.

$ npm install -g zoho-extension-toolkit@latest

Ejecute el siguiente comando ZET para comprobar la instalación. Se mostrarán los detalles de ayuda acerca de los diversos comandos de soporte:

$ zet

Crear un proyecto

Cree un proyecto con el comando siguiente:

$ zet init

Se muestra la lista de servicios de Zoho. Seleccione Zoho Mail y presione Ingresar.

Se le solicitará que proporcione un nombre de proyecto. Escriba el nombre de proyecto que prefiera y presione Ingresar.

Incluir recursos

Una vez que ingrese el nombre del proyecto, se crea un directorio con el mismo nombre en el sistema. Contiene todas las carpetas, archivos y paquetes necesarios.

Vaya al directorio del proyecto y abra la carpeta "App". Incluya los recursos de su widget en las subcarpetas correspondientes.

Ejecutar el servidor

Ejecute el siguiente comando para iniciar el servidor http que ejecuta la extensión localmente:

$ zet run

Este comando utiliza el puerto 5000 de su equipo local. Antes de iniciar el servidor, asegúrese de que el puerto 5000 no esté ocupado.

Para comprobar que el servidor se ejecuta correctamente, abra la URL dada en su navegador:

http://127.0.0.1:5000/

Validar y empaquetar

Ejecute el siguiente comando para validar su extensión:

$ zet validate

Su extensión debe seguir la especificación que se indica a continuación. La ejecución del comando de validación identificará cualquier infracción de las especificaciones, si las hubiera. Cualquier infracción de este tipo debe rectificarse antes de cargar el archivo zip.

Ejecute el siguiente comando de paquete para crear un archivo zip con todos los archivos y carpetas necesarios para ejecutar la extensión:

$ zet pack

El zip está presente en la carpeta "dist" del directorio del proyecto. Puede cargar este zip en Marketplace.

Especificación

El directorio del proyecto de su extensión incluye un archivo plugin-manifest.json. Este archivo contiene los detalles de configuración de su extensión. Las claves incluidas en este archivo deben seguir la siguiente configuración:

• locale: esta es la localidad predeterminada para las extensiones. La carpeta de traducción del directorio de su proyecto debe contener todos los archivos de traducción. El formato de los archivos debe ser “<locale-code>.json”.
• service*: el producto de Zoho para el cual se creó su extensión.
  • Mientras crea una extensión para Zoho Mail, la clave del servicio se completará automáticamente en el manifiesto como “service”: “MAIL”.
• storage: el valor de esta clave debe establecerse como “true” si desea que la extensión almacene los datos de la aplicación.
• logo: la ruta del archivo de la imagen que desea utilizar como el logotipo de su extensión. Ej.: “apps/images/logo.png”
• modules*: el widget es el módulo utilizado para las extensiones de Zoho Mail. Es un arreglo de los detalles de su extensión. El módulo del widget debe tener el siguiente conjunto de propiedades.
  • location: ubicación del widget en el producto de Zoho.
    • Debe ser “zoho.mail.preview.rightpanel” para Zoho Mail, a fin de acceder a su extensión en el panel de widgets.
      
    • Debe ser “zoho.mail.pinnedview.rightpanel” si desea realizar acciones rápidas con el widget. El widget estará disponible para fijarse al panel derecho. Consulte aquí para fijar un widget al panel derecho.
      

    • Debe ser “zoho.mail.preview.moreoption”, si desea incluir la aplicación en la opción Agregar a del cuadro de selección Más opciones en el panel de vista previa de correo.
      ​ ​

      Esta API se puede utilizar para abrir la extensión en el panel de widgets desde la ventana de acción rápida o viceversa.

  • name: nombre del directorio del proyecto del widget. Se completa automáticamente.

  • url: es la ruta definida para su widget.

    EJEMPLO DEL MANIFIESTO: Para acceder al widget en el panel derecho
    
    "modules": {
    "widgets": [
    ​ {
    "location": "zoho.mail.preview.rightpanel",
    "name": "extension_name",
    "url": "/app/widget.html"
    }
    ]
    ​ }

  • EJEMPLO DEL MANIFIESTO: Para realizar acciones rápidas con el widget en la vista fijada
    
    ​"modules": {
    "widgets": [
    ​ {
    "location": "zoho.mail.preview.rightpanel",
    "name": "extension_name",
    "url": "/app/widget.html"
    }
    ​​{
    "location": "zoho.mail.pinnedview.rightpanel",
    "name": "extension_name",
    "url": "/app/widget.html"
    }
    ]
    ​ }

  • EJEMPLO DEL MANIFIESTO: Para incluir la aplicación en la opción Agregar a del cuadro de selección Más opciones de la vista previa del correo.
    
    ​"modules": {
    "widgets": [
    ​ {
    "location": "zoho.mail.preview.rightpanel",
    "name": "extension_name",
    "url": "/app/widget.html"
    }
    {
    "location": "zoho.mail.preview.moreoption",
    "name": "extension_name",
    "url": "/app/widget.html"
    }
    ​​{
    "location": "zoho.mail.pinnedview.rightpanel",
    "name": "extension_name",
    "url": "/app/widget.html"
    }
    ]
    ​ }