Apps personalizados

Apps personalizados são desenvolvidos exclusivamente para a loja da Shopify, diferentemente dos apps públicos, que são criados para funcionar com várias lojas. É possível usar apps personalizados para adicionar recursos ao admin da Shopify, acessar dados da loja diretamente com as APIs da Shopify ou levar a loja virtual a outras plataformas por meio da API Storefront.

A criação de um app personalizado é um processo desafiador, que exige conhecimento especializado. Por isso, se você precisar de ajuda nessa tarefa, lembre-se de que é possível contratar um Especialista da Shopify.

Se você quiser que uma conta de colaborador ou membro da equipe tenha permissão para criar, editar ou excluir apps personalizados, basta conceder a permissão Desenvolver apps. Não esqueça que essa conta também precisa ter as permissões necessárias para definir determinados escopos de API.

Habilitar o desenvolvimento de apps personalizados no admin da Shopify

Antes de criar, você precisa habilitar o desenvolvimento de apps personalizados para a loja. É importante destacar que apenas o titular da loja pode dar essa permissão.

Etapas:

  1. No admin da Shopify, acesse Apps.

  2. Clique em Desenvolver apps.

  3. Clique em Permitir desenvolvimento de apps personalizados.

  4. Leia o aviso e as informações mostradas e clique em Permitir o desenvolvimento de apps personalizados.

Criar e instalar um app personalizado

Depois de habilitar o desenvolvimento, é possível criar e instalar um app personalizado no admin da Shopify. Lembre-se de que é preciso definir os escopos da API para determinar a quais partes da loja o app personalizado terá acesso. Após a instalação, você receberá os tokens usados pelo app para acessar as informações da loja por meio das APIs da Shopify.

Se tiverem as permissões necessárias, o titular da loja, os colaboradores e os membros da equipe poderão criar e instalar apps personalizados.

Criar o app

  1. No admin da Shopify, acesse Apps.

  2. Clique em Desenvolver apps.

  3. Clique em Criar um app personalizado.

  4. Na janela modal, digite o Nome do app e selecione um Desenvolvedor do app. Este último pode ser o titular da loja, uma conta de colaborador ou um membro da equipe que tenha a permissão Desenvolver apps.

  5. Clique em Criar app.

Selecionar escopos da API

Após a criação, é possível atribuir escopos da API Admin, da API Storefront ou de ambas, de acordo com os requisitos do app personalizado.

  1. Clique em Selecionar escopos.

  2. Na seção Escopos de acesso da API Admin, escolha os escopos de API que serão atribuídos ao app.

    1. Opcional: defina a versão da API que você quer usar para assinaturas de webhook.
    2. Opcional: é possível configurar o Google Cloud Pub/Sub para lidar com as assinaturas de webhook do app. Para fazer isso, na seção Google Cloud Pub/Sub, copie o endereço da conta de serviço da Shopify e use essa informação para configurar a conta do Google Cloud Pub/Sub.
    3. Opcional: é possível configurar o Amazon EventBridge para lidar com as assinaturas de webhook do app. Para fazer isso, na seção Amazon EventBridge, clique em Criar origem.
  3. Na seção Escopos de acesso da API Storefront, escolha os escopos de API que você quer atribuir ao app.

  4. Clique em Salvar.

Instalar o app e receber os tokens de acesso à API

Após definir os escopos da API, instale o app. Somente depois disso você terá os tokens de acesso à API, que variam de acordo com os escopos atribuídos. Portanto, você pode receber um token de acesso da API Admin, da API Storefront ou de ambas.

  1. Clique em Instalar app.

  2. Na janela modal, clique em Instalar app.

  3. Receba o token de acesso:

  • Se você selecionou os escopos da API Admin para o app, acesse a seção Token de acesso da API Admin e clique em Revelar token uma vez.
  • Se você selecionou os escopos da API Storefront para o app, acesse a seção Token de acesso da API Storefront e copie as informações. Ao contrário do token de acesso da API Admin, esse token está sempre disponível nesta página.

Depois de revelar o token de acesso completo uma vez, a página mostrará só os últimos quatro dígitos, para fins de consulta.

Localizar as credenciais da API de um app personalizado

É possível conferir o token de acesso da API Storefront, a chave de API e o segredo da API de um app personalizado na página de credenciais da API. Lembre-se de que outra opção é consultar o token de acesso da API Admin, mas, após vê-lo uma vez, você só poderá verificar os quatro últimos dígitos.

  1. No admin da Shopify, acesse Apps.

  2. Clique em Desenvolver apps.

  3. Clique no nome do app cujas credenciais você quer localizar.

  4. Clique em Credenciais da API.

Atualizar escopos da API Admin de um app personalizado

Se você é titular da loja, colaborador ou membro da equipe com as permissões necessárias, pode atualizar os escopos de um app personalizado.

  1. No admin da Shopify, acesse Apps.

  2. Clique em Desenvolver apps.

  3. Clique no nome do app que você quer atualizar.

  4. Clique em Configuração.

  5. Na seção Integração da API Admin, clique em Editar.

Caso você ainda não tenha atribuído escopos à API Admin, clique em Configurar.

  1. Selecione os escopos que você quer atribuir ao app.

  2. Opcional: defina a versão da API que você quer usar para assinaturas de webhook.

  3. Opcional: é possível configurar o Google Cloud Pub/Sub para lidar com as assinaturas de webhook do app. Para fazer isso, na seção Google Cloud Pub/Sub, copie o endereço da conta de serviço da Shopify e use essa informação para configurar a conta do Google Cloud Pub/Sub.

  4. Opcional: é possível configurar o Amazon EventBridge para lidar com as assinaturas de webhook do app. Para fazer isso, na seção Amazon EventBridge, clique em Criar origem.

  5. Clique em Salvar.

Se o app já estiver instalado na loja, você não terá a opção Salvar, a menos que um escopo esteja selecionado ou caso o app tenha os escopos da API Storefront atribuídos.

Atualizar os escopos de acesso da API Storefront de um app personalizado

Se você é titular da loja, colaborador ou membro da equipe com as permissões necessárias, pode atualizar os escopos de um app personalizado.

  1. No admin da Shopify, acesse Apps.

  2. Clique em Desenvolver apps.

  3. Clique no nome do app que você quer atualizar.

  4. Clique em Configuração.

  5. Na seção Integração da API Storefront, clique em Editar.

Caso você ainda não tenha atribuído escopos à API Storefront, clique em Configurar.

  1. Selecione os escopos que você quer atribuir ao app.

  2. Opcional: caso o app tenha integração com o SDK Buy para iOS, faça as alterações necessárias na seção correspondente. Vale lembrar que só será possível modificar essa seção se o app já tiver sido instalado.

Consulte a documentação para desenvolvedores do SDK Buy para iOS e veja instruções mais detalhadas. Atenção: a página em questão está disponível apenas em inglês.

  1. Opcional: caso o app tenha integração com o SDK Buy para Android, faça as alterações necessárias na seção correspondente. Vale lembrar que só será possível modificar essa seção se o app já tiver sido instalado.

Consulte a documentação para desenvolvedores do SDK Buy para Android e veja instruções mais detalhadas. Atenção: a página em questão está disponível apenas em inglês.

  1. Clique em Salvar.

Se o app já estiver instalado na loja, você não terá a opção Salvar, a menos que um escopo esteja selecionado ou caso o app tenha os escopos da API Storefront atribuídos.

Atualizar configurações de um app personalizado

É possível atualizar o nome, a descrição e o desenvolvedor do app.

Se você definir o desenvolvedor do app como uma conta de membro da equipe ou colaborador e excluí-la posteriormente, o titular da loja se tornará o desenvolvedor do app por padrão.

  1. No admin da Shopify, acesse Apps.

  2. Clique em Desenvolver apps.

  3. Clique no nome do app que você quer atualizar.

  4. Clique em Configurações do app.

  5. Para alterar o nome ou a descrição, insira um novo Nome do app ou uma Descrição do app.

  6. Para alterar o desenvolvedor associado ao app, selecione um Desenvolvedor do app.

  7. Clique em Salvar.

Desinstalar um app personalizado

Quando você desinstala um app personalizado, os tokens de acesso das APIs Admin e Storefront são revogados e não podem mais acessar os dados da loja. Portanto, se você instalar o app de novo, terá novos tokens de acesso.

  1. No admin da Shopify, acesse Apps.

  2. Clique em Desenvolver apps.

  3. Clique no nome do app que você quer desinstalar.

  4. Clique em Desinstalar app.

Excluir um app personalizado

Quando você exclui um app personalizado, não é possível recuperá-lo. Se você quiser desabilitar temporariamente um app na loja sem excluí-lo, desinstale o app.

  1. No admin da Shopify, acesse Apps.

  2. Clique em Desenvolver apps.

  3. Clique em Configurações do app.

  4. Clique em Excluir app.

Permissões de escopo da API para apps personalizados

Contas de colaborador e membro da equipe só poderão definir escopos da API para apps personalizados se tiverem a permissão Desenvolver apps, bem como outras permissões de equipe relacionadas aos escopos da API definidos.

Consulte o desenvolvedor do app para saber quais permissões de conta e escopos da API são necessários para o funcionamento do app personalizado. Vale lembrar que o ideal é que você entenda e se sinta confortável com as permissões concedidas ao desenvolvedor.

Tudo pronto para começar a vender com a Shopify?

Experimente de graça