📝 Índice
Introdução
- O que é zcli?
Começando com zcli
- Instalando zcli
- Adicionando um Perfil
- Criando Arquivos Iniciais para um Novo Aplicativo Zendesk
- Testando o Aplicativo Localmente
- Implantação do Aplicativo em sua Instância Zendesk
- Atualizando um Aplicativo em sua Instância Zendesk
Limitações do zcli
- Limitações Atuais
- Possíveis Soluções Alternativas
Tópicos e Comandos Avançados
- Recursos Futuros
- Sugestões para Tópicos Futuros
Conclusão
Introdução
Você está procurando uma interface de linha de comando que possa ajudar a construir e gerenciar seus aplicativos Zendesk? Não procure mais do que zcli! Neste artigo, exploraremos o que é zcli, por que foi criado e algumas de suas limitações atuais. Também mostraremos como criar e executar um aplicativo simples usando o framework de aplicativos Zendesk juntamente com zcli. Por fim, falaremos sobre algumas das coisas empolgantes que temos planejadas para o futuro do zcli.
O que é zcli?
Zcli é uma interface de linha de comando que ajuda a construir e gerenciar seus aplicativos Zendesk. Com zcli, você pode criar novos aplicativos, enviá-los diretamente para sua instância Zendesk e atualizá-los conforme necessário diretamente do terminal. Zcli é construído com Node.js usando o framework OpenCLI, o que resulta em uma experiência de desenvolvedor muito mais suave e suporte nativo ao Windows. Isso significa que não é mais necessário instalar o Linux em máquinas Windows para executar as ferramentas de aplicativos Zendesk anteriores, além de compatibilidade total com M1 Max.
Começando com zcli
Instalando zcli
Para começar com zcli, você precisará instalá-lo primeiro. É necessário o Node v12 ou superior, então você pode verificar a versão do seu node executando `node -v` no terminal. Você verá o número da versão retornado, que no meu caso é a versão 16.13. Se sua versão for anterior à v12, você pode atualizá-la usando o Node Version Manager ou acessando o site do Node para baixar as atualizações necessárias.
Em seguida, você pode prosseguir e instalar zcli executando o comando `npm install @zendesk/zcli -g` no terminal. É isso! Você pode confirmar a versão instalada executando `zcli -v`.
Adicionando um Perfil
Um perfil no zcli corresponde às suas credenciais de login no Zendesk, e o zcli suporta um perfil por subdomínio. Você será solicitado a inserir seu endereço de e-mail, senha e o subdomínio de sua instância Zendesk. Se você desativou o acesso por senha, pode usar um token de API no formato `email/token`.
Para adicionar um perfil, execute o comando `zcli login -i` no terminal. Você será solicitado a inserir seu subdomínio, e-mail e senha. Em termos de segurança, o zcli salva suas credenciais de forma segura no keystore do seu sistema operacional.
Criando Arquivos Iniciais para um Novo Aplicativo Zendesk
Assim como as ferramentas de aplicativos Zendesk, existem algumas maneiras diferentes de gerar arquivos iniciais para seu aplicativo. Para os fins deste artigo, vamos nos ater aos arquivos de dados básicos de aplicativos.
Para começar, vamos `cd` para a área de trabalho, pois é onde queremos que o diretório do aplicativo fique. Em seguida, executaremos o comando `zcli apps new`. A primeira solicitação que você verá é para inserir um nome de diretório para os arquivos do aplicativo. Se você já tiver um criado, pode inseri-lo aqui. Caso contrário, você pode inserir um novo nome de pasta que será criada para armazenar o aplicativo. Vamos criar um novo diretório chamado `ccli-example`.
Em seguida, você será solicitado a inserir o nome do autor do aplicativo, o endereço de e-mail e um nome para o aplicativo. Veremos em um minuto onde esses detalhes podem ser atualizados, mas por enquanto, eles podem ser o que você quiser. Você verá uma mensagem de sucesso informando que o projeto foi criado.
Vamos `cd` para o diretório do projeto e abrir os arquivos no VS Code. Aqui temos nossa pasta de ativos e traduções, que contém tudo o que precisamos para criar um aplicativo simples no Zendesk. Também temos nosso arquivo `manifest.json`, que contém os metadados do aplicativo, incluindo o nome do aplicativo, nome do autor e endereço de e-mail que inserimos alguns momentos atrás.
Testando o Aplicativo Localmente
Usando zcli, podemos iniciar um servidor web local para executar um aplicativo Zendesk em seu computador. Isso facilita a construção e teste, pois você não precisa fazer upload e instalação do pacote toda vez que fizer alterações durante o desenvolvimento do aplicativo.
Para iniciar o servidor, executaremos o comando `zcli apps server` no terminal. Após alguns segundos, você verá que o servidor do aplicativo está sendo executado em `localhost:4567`. Em seguida, precisaremos adicionar `zcli_apps=true` ao final da URL de sua instância Zendesk, da mesma forma que você pode ter feito no passado.
Como o aplicativo é especificado como um aplicativo de barra lateral de tíquete por padrão, vamos para um tíquete e fazer isso agora. E pronto! Nosso aplicativo totalmente funcional agora está aparecendo na bandeja de aplicativos de barra lateral de tíquete. Podemos fazer uma alteração no aplicativo, voltar ao tíquete, atualizar a página e as alterações serão atualizadas adequadamente.
Quando você estiver pronto para encerrar a sessão do servidor, basta pressionar `ctrl + c` na janela do terminal e remover a seção adicionada da URL do Zendesk. Algumas limitações a serem observadas ao testar um aplicativo localmente são que as configurações seguras não serão renderizadas ao usar o servidor zcli. Além disso, se você tiver requisitos em um arquivo de configuração de aplicativos zcli, eles não serão instalados ao usar o servidor zcli. Em ambos os casos, o aplicativo precisará ser instalado em sua instância Zendesk, o que abordaremos a seguir.
Implantação do Aplicativo em sua Instância Zendesk
Depois que seu aplicativo for testado e estiver pronto para ser implantado, as etapas seguintes são validar e empacotar o aplicativo e fazer upload e instalação do aplicativo em sua instância Zendesk. Isso é feito usando um único comando simples, o comando `zcli apps create`.
No terminal, execute o comando `zcli apps create`, que iniciará o processo de validação, empacotamento e upload do aplicativo em sua instância Zendesk. Se você encontrar algum erro durante o processo de instalação, precisará atualizar o aplicativo conforme necessário.
