Passar para o conteúdo principal

Deeplink: Configuração para VTEX e Shopify (assetlinks e AASA)

b
Escrito por bruno bulso

Esta seção detalha os passos e considerações para configurar e ativar o Deeplink em sua plataforma.

Pré-requisitos

  • Plataforma: A configuração de Deeplink pode variar dependendo da sua plataforma de e-commerce (ex: VTEX, Shopify).

  • Acesso: É necessário ter acesso administrativo à sua plataforma de e-commerce e, em alguns casos, acesso ao console de desenvolvedor do aplicativo.

  • Arquivos de Configuração: Para Android e iOS, os arquivos assetlinks.json e apple-app-site-association respectivamente, são essenciais.

Configuração para Plataformas VTEX

Para clientes que utilizam a plataforma VTEX, a configuração de Deeplink geralmente envolve os seguintes passos:

  1. Adição de Arquivos de Configuração:

    • É necessário solicitar à VTEX ou à agência responsável pelo site a adição dos arquivos assetlinks.json (para Android) e apple-app-site-association (para iOS) nos seguintes caminhos:

      • Android:https:///.well-known/assetlinks.json

      • iOS:https:///.well-known/apple-app-site-association

    • Observação: O caminho /.well-known/ é um padrão oficial e não pode ser alterado. Certifique-se de que o CDN ou proxy da sua infraestrutura (como Cloudflare) esteja configurado para encaminhar requisições para este caminho corretamente para o serviço VTEX IO.

  2. Credenciais de API (AppKey e AppToken):

    • Para que a integração seja realizada do nosso lado, precisamos que nos forneçam as credenciais de API (AppKey e AppToken).

    • Essas chaves devem possuir permissão para chamadas públicas.

    • Podem ser geradas pelo próprio time de vocês, seguindo a documentação oficial da VTEX: https://help.vtex.com/pt/docs/tutorials/chaves-geradas#gerar-chave

    • Recomendamos que o acesso seja concedido com perfil Owner (Admin Super) com liberação para todos os recursos. Se possível, configurem como chave permanente para agilizar futuros ajustes.

  3. Validação:

    • Após a adição dos arquivos e o fornecimento das credenciais, nossa equipe realizará testes para validar a configuração.

Configuração para Plataformas Shopify

Para clientes que utilizam a plataforma Shopify, o processo difere ligeiramente:

  1. Adição Manual de Arquivos:

    • Ainda é necessário que os arquivos assetlinks.json e apple-app-site-association sejam adicionados manualmente nos caminhos do domínio.

    • Recomenda-se solicitar diretamente à Shopify ou à agência responsável a publicação desses arquivos nos seguintes caminhos:

      • Android:https:///.well-known/assetlinks.json

      • iOS:https:///.well-known/apple-app-site-association

Considerações Gerais e Solução de Problemas

  • Universal Links e App Links: Os caminhos /.well-known/apple-app-site-association e /.well-known/assetlinks.json são requisitos técnicos das plataformas (Apple e Android) e não podem ser alterados.

  • Erro "token not found" ou 404: Se você encontrar este erro, verifique a configuração do CDN ou proxy da sua infraestrutura. O problema geralmente está na camada que antecede a VTEX, que pode estar bloqueando ou não repassando requisições para o caminho /.well-known/.

  • Deeplink Dinâmico e UTMs:

    • A criação de links inteligentes (com UTMs, direcionamento para lojas de aplicativos, tracking, etc.) geralmente é feita por plataformas especializadas como Awin, Adjust, ou outras ferramentas de mercado.

    • Nosso aplicativo é capaz de interpretar esses deeplinks, mas a geração e gerenciamento deles devem vir de uma ferramenta externa.

  • Redirecionamento para Landing Pages:

    • O deeplink nativo não suporta o redirecionamento direto para Landing Pages. Para essa funcionalidade, é necessário utilizar ferramentas como Appsflyer e configurar o OneLink.

  • Ajustes de Código e Novas Versões:

    • Muitas configurações de deeplink exigem alterações no código do aplicativo e a publicação de uma nova versão nas lojas (Apple App Store e Google Play Store). Este processo inclui revisão de código, testes e o tempo de aprovação das lojas.

  • Permissões de API:

    • Ao solicitar chaves de API (AppKey e AppToken), certifique-se de que elas tenham permissão para chamadas públicas. Para configurações específicas, pode ser necessário o perfil Owner (Admin Super). Se houver restrições internas, informe quais permissões específicas são necessárias para que possamos avaliar alternativas.

  • Desativação de Deeplink:

    • Para desativar o deeplink, é necessário um ajuste no código do aplicativo e a submissão de uma nova versão para as lojas.

  • Testes e Propagação:

    • Após a implementação, pode haver um pequeno tempo de propagação para que as atualizações sejam refletidas em todos os dispositivos. Desinstalar e reinstalar o aplicativo pode ajudar a forçar a atualização.

  • Dynamic Content (Insider):

    • Atributos como Last Visited Product ID e Last Visited Product Name geralmente funcionam conforme esperado.

    • Atributos como Last Abandoned Product ID e Last Abandoned Product Name podem ter limitações na plataforma da Insider. Verifique com a Insider ou sua agência para mais detalhes e possíveis melhorias.

Informações Necessárias para Solicitação

Para agilizar o processo de configuração ou solução de problemas, tenha em mãos:

  • URL do seu site/domínio.

  • AppKey e AppToken (se aplicável).

  • Exemplos de URLs que precisam de configuração específica.

  • Vídeos ou prints evidenciando o comportamento (se aplicável).

  • Versão do aplicativo e do sistema operacional (em caso de problemas específicos de dispositivo).

Divisão de Responsabilidades

O que é responsabilidade do Cliente:

  • Gerar AppKey e AppToken com as permissões corretas na VTEX.

  • Solicitar à agência ou plataforma a adição dos arquivos assetlinks.json e apple-app-site-association no domínio.

O que é responsabilidade da Kobe:

  • Integração técnica no código do aplicativo.

  • Publicação de nova versão nas lojas (App Store e Google Play), incluindo revisão de código, testes e aprovação das lojas.

Respondeu à sua pergunta?