Olá, vamos mostrar como é feito a integração mobile de um app, com o Zendesk Support, utilizando especificamente o SDK mobile para Android.
Importante: Ao final desse artigo tem o link com os fonte do aplicativo no Github de um projeto exemplo da Tecna e de um projeto da Zendesk.
Este artigo abrange os seguintes tópicos:
- Diferença entre SDK Unificado e SDK Clássico
- Como evitar erros de compilação inicial do app
- Guia de como adicionar o Guide (base de conhecimento de artigos) no app
- Criando sua própria UI via API Provider Zendesk
1. Diferença entre SDK Unificado e SDK Clássico
O SDK unificado surgiu recentemente, a diferença dele com o clássico é que no Unificado é possível integrar além do canal Supporte, demais canais como: Chat, Answerbot e app, porém mesmo se você não tiver tais funcionalidades de chat, answerbot etc... é recomendado utilizar o SDK Unificado.
Obs: É possível integrar o Guide com os dois tipos de SDK
Obs: Você pode utilizar métodos do SDK Clássico no Unificado. Ex: métodos do HelpCenter que estão na documentaçao do Clássico.
Abaixo, o link sobre essa introdução aos 2 tipos de SDKs
2. Como evitar erros de compilação inicial do app.
A Zendesk se destaca das demais soluções de CRM, por entregar justamente uma ferramenta onde é bem fácil e intuitivo seu funcionamento, na integração com o SDK mobile não é diferente, mas é possível passar por algumas situações de bugs e o intuito dessa seção é tentar facilitar e sanar o surgimento de possíveis bugs iniciais.
Para você ter o retorno de algo rodando na interface com o SDK é preciso seguir 4 passos:
- Adicionar dependencias no projeto
- Inicializar o SDK
- Identificar os usuários
- Adicionar as activities e builders
2.1 Adicionar dependências
A primeira etapa de adicionar as dependências do projeto é a mais importante, atualmente o Zendesk sugere a utilização da versão 4.0.0, é importante utilizar sempre a versão sugerida na documentação.
É nessa etapa que você pode adicionar o repositório da Zendesk as dependências no seu projeto.
2.1.1 Possíveis bugs
Os bugs mais recorrentes se dão nesta fase, por isso uma dica muito importante é: tente utilizar um módulo específico para a aplicação rodar, foi observado em algumas dúvidas na comunidade de Devs e em alguns clientes que, ao inicializar o SDK dependendo da quantidade de outros frameworks e dependências que você possua em seu ambiente, há possibilidade de incompatibilidade ao inicializar o projeto aumenta.
Para isso sugerimos ou seguir inicialmente seguir esses quatro passos ou melhor ainda, nós da Tecna iramos disponibilizar ao final do artigo um projeto de exemplo onde você poderá recorrer caso haja dúvidas pontuais e também um projeto de samples da Zendesk, que é mais abrangente.
2.2 Inicializar o projeto
Nesta etapa é onde o admin da conta Zendesk precisa fazer o vinculo do Support com o SDK, clique em Admin > SDK para dispositivos móveis, adicione um aplicativo, descendo a barra de rolagem o Zendesk irá disponibilizar um trecho de código para Android/IOS que é justamente a inicialização chamando alguns IDs como variáveis.
2.3 Identificar os usuários
O SDK possui duas formas de autenticação, para acesso anônimo e JWT.
Essa escolha vai depender da regra de negócios da sua empresa, por exemplo se você não precisa saber os dados do seu usuário final, é plausível a utilização da autenticação anônima, apesar de recomendarmos a JWT, para ter uma segurança e controle maior dos dados. para saber mais a fundo sobre as duas autenticações, Clique aqui!
2.4 Adicionar as activities e builders
Com o projeto inicializado, agora é hora de começarmos chamar métodos e funções no nosso código para criar condicionantes no projeto e renderizarmos alguma funcionalidade, no tópico adiante iremos mostrar como adicionamos a activities do Guide, na figura abaixo é um exemplo claro onde, é criado um builder de menssageActivity, e dentro dele, e criado um engine do support e logo depois um método para mostrar ele na tela da instancia criada do seu app.
3. Guia de como adicionar os artigos do Guide no seu app
Obs: Apesar da documentação da Zendesk que fala sobre o Guide, estar na seção do SDK Clássico, é possível utiliza-lo no SDK Unificado.
https://developer.zendesk.com/embeddables/docs/android-support-sdk/help_center
Pontos importantes:
1. Primeiramente, certifique-se que seu Guide esteja ativado ativado e que possui artigos.
2. Seu Guide tenha pelo menos um artigo publicado.
3. Os dados de inicialização do SDK estão corretos, com IDs da sua base etc...
4. Se você tiver algum tema no seu app que possua herança com
Theme.AppCompat
pode ocorrer alguma incompatibilidade, e importante lembrar que é possível sim criar sua própria UI, utilizando a API Provider
Agora para renderizar os artigos na sua UI, simplesmente escreva o código abaixo:
HelpCenterActivity.builder() .show(MyActivity.this);
Se todos os passos importantes foram seguidos, o método show(), irá renderizar os artigos do seu Guide, para a UI.
Documentação do Zendesk sobre adicionar o help center:
https://developer.zendesk.com/embeddables/docs/android-support-sdk/help_center#adding-help-center
4. API Provider
A API Provider é uma maneira de você conseguir interagir com alguns dados do Zendesk, usando funções assíncronas capazes de retornar valores que serão usados em customizações do seu app mobile sem precisar de ser um admin, essa ferramenta é importante porque não te exige consumir a REST API do Zendesk, que dependendo do endpoint terá como premissa a obrigatoriedade de autenticação passando por um administrador.
Voce pode acessar aqui, a API Provider mostrada na imagem abaixo, ela é dividida em 5 partes
Dentre elas podemos destacar o pacote do Support, que é o mais completo entre eles, possui várias classes, cada classe possui métodos específicos que podem retornar dados à serem utilizados na integração do app e personalização do UI.
Ex: Neste exemplo, acessamos o pacote do Support que nos mostra alguns métodos onde é possível recuperar dados de tickets, como, data de criação, colaboradores etc...
Sample Tecna:
https://github.com/crmway/tecna-zendesk-sample-android
Sample Zendesk:
https://github.com/zendesk/sdk_demo_app_android
Esperamos ter ajudado!
Equipe Tecna!
Comentários
0 comentário
Artigo fechado para comentários.