Developer Space – desenvolver extensão

A seção Desenvolver extensão no Developer Space permite que você crie suas próprias extensões eWidget. A extensão que você cria pode ser instalada a partir do Marketplace e usada por outros usuários.

Zoho Marketplace

O Zoho Marketplace é a plataforma on-line que oferece extensões e widgets que ajudam os usuários a aprimorar seu fluxo de trabalho em vários aplicativos. Os usuários podem instalar as extensões do Zoho Marketplace para aproveitar as funções existentes dos aplicativos Zoho.

Além das extensões já disponíveis, os desenvolvedores agora podem criar extensões mais abrangentes para o Zoho Mail. Essas extensões podem ser criadas para integrar as funções do Zoho Mail com os recursos dos aplicativos de terceiros. Isso ajuda os usuários a criar extensões para atender aos requisitos personalizados.

Depois de criar a extensão, você terá que enviá-la para uma revisão. Depois de analisar a funcionalidade, sua extensão será aprovada e será publicada no Zoho Marketplace, que estará disponível para todos os usuários do Zoho instalarem e usarem.

Desenvolvimento da extensão

Você pode começar a criar sua extensão diretamente a partir da plataforma Zoho Sigma usando um manifesto de plug-in do Zoho Mail pré-preenchido. Como alternativa, você também pode usar a CLI do ZET para criar sua extensão e, em seguida, carregar o arquivo no Zoho Sigma para envio.

Criar extensão no Zoho Sigma

Para começar, crie uma área de trabalho para você no Zoho Sigma com as seguintes etapas:

1. Faça login no Zoho Sigma
2. Insira o nome da área de trabalho
3. Clique em Criar área de trabalho

Depois de criar sua área de trabalho, clique no botão Nova extensão no canto superior direito. Insira os detalhes, como nome e descrição, e selecione Zoho Mail na seção Serviço. Em seguida, clique em Salvar como rascunho e siga as instruções detalhadas fornecidas nesta página de ajuda para começar a criar sua extensão no Sigma.

Criando a extensão com a CLI do ZET

A interface de linha de comando (CLI) é usada para criar e empacotar widgets. O comando Zet é a CLI usada para empacotar widgets para o Zoho Mail.

Pré-requisitos

Para criar seus próprios widgets para o Zoho Mail, é necessário baixar o nodejs. Você pode baixá-lo aqui. (As versões abaixo de 7 não são compatíveis)

Você pode verificar o nó executando os seguintes comandos:

$ node -v verifica a versão do nó.
$ npm -v verifica a versão do npm.

Instalação

Instale a CLI do ZET (kit de extensão Zoho) usando o comando abaixo.

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

Execute o comando ZET abaixo para verificar a instalação. Os detalhes de ajuda sobre os vários comandos de suporte serão exibidos:

$ zet

Criação de um projeto

Crie um projeto com o seguinte comando:

$ zet init

A lista do Zoho Services é exibida. Escolha Zoho Mail e pressione Enter.

Você será solicitado a fornecer um nome de projeto. Digite o nome de projeto preferido e pressione Enter.

Inclusão de recursos

Depois de inserir o nome do projeto, um diretório com o mesmo nome é criado no sistema. Ele contém todas as pastas, arquivos e pacotes necessários.

Navegue até o diretório do projeto e abra a pasta "App". Inclua os recursos do widget nas subpastas relevantes.

Execução do servidor

Execute o seguinte comando para iniciar o servidor HTTP que executa sua extensão localmente:

$ zet run

Este comando usa a porta 5000 da sua máquina local. Antes de iniciar o servidor, verifique se a porta 5000 não está ocupada.

Para verificar se o servidor está sendo executado com êxito, abra o URL fornecido no navegador:

http://127.0.0.1:5000/

Validar e empacotar

Execute o seguinte comando para validar sua extensão:

$ zet validate

Sua extensão precisa seguir a especificação abaixo. A execução do comando Validate identificará quaisquer violações das especificações, se houver. Quaisquer violações precisam ser corrigidas antes de carregar o zip.

Execute o comando de pacote abaixo para criar um zip com todos os arquivos e pastas necessários para a execução de sua extensão:

$ zet pack

O zip está presente na pasta dist do diretório do seu projeto. Você pode carregar este zip no Marketplace.

Especificação

O diretório do projeto de sua extensão inclui um arquivo plugin-manifest.json. Este arquivo contém os detalhes de configuração de sua extensão. As chaves incluídas neste arquivo precisam ter a seguinte configuração:

• locale: este é o local padrão para as extensões. A pasta de tradução do diretório do projeto deve conter todos os arquivos de tradução. O formato dos arquivos deve ser "<locale-code>.json".
• service*: o produto Zoho para o qual sua extensão foi criada.
  • Ao criar uma extensão para o Zoho Mail, a chave de serviço será preenchida automaticamente no manifesto como "service": "MAIL".
• storage: o valor dessa chave deve ser definido como "verdadeiro" se quiser que a extensão armazene dados do aplicativo.
• logo: caminho do arquivo da imagem a ser usado como logotipo para sua extensão. Ex.: "apps/images/logo.png"
• modules*: o widget é o módulo usado para extensões do Zoho Mail. É uma matriz dos detalhes de sua extensão. O módulo de widget deve ter o seguinte conjunto de propriedades.
  • location: localização do seu widget no produto Zoho.
    • Deve ser "zoho.mail.preview.rightpanel" para o Zoho Mail a fim de acessar sua extensão no painel de widgets.
      
    • Deve ser "zoho.mail.pinnedview.rightpanel" se quiser realizar ações rápidas usando seu widget. O widget estará disponível para ser fixado no painel direito. Consulte aqui para fixar um widget no painel direito.
      

    • Deve ser "zoho.mail.preview.moreoption" se quiser incluir o aplicativo na opção Add to (Adicionar a) do menu suspenso More options (Mais opções) no painel de visualização de e-mails.
      ​ ​

      Essa API pode ser usada para abrir a extensão no painel do widget pela janela de ação rápida ou vice-versa.

  • name: nome do diretório do projeto do seu widget. Ele é preenchido automaticamente.

  • url: é o caminho definido para o widget.

    AMOSTRA DE MANIFESTO: Para acessar o widget no painel direito 
    
    "modules": {
    "widgets": [
    ​ {
    "location": "zoho.mail.preview.rightpanel",
    "name": "extension_name",
    "url": "/app/widget.html"
    }
    ]
    ​ }

  • AMOSTRA DE MANIFESTO: Para realizar ações rápidas usando o widget na exibição fixada
    
    "módulos": {
    "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"
    }
    ]
    ​ }

  • AMOSTRA DE MANIFESTO: Para incluir o aplicativo na opção Add to (Adicionar a) no menu suspenso More options​(Mais opções) no painel de visualização de e-mails.
    
    ​"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"
    }
    ]
    ​ }