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.

Observação

Esta página explica como criar e autenticar um app personalizado no admin da Shopify, seja você o titular da loja ou um desenvolvedor com uma conta de colaborador ou membro da equipe. Caso você seja um desenvolvedor, leia a documentação sobre apps personalizados para saber mais.

A criação de um app personalizado é um processo desafiador, que exige conhecimento especializado. Se você precisar de ajuda na hora de criar apps personalizados para a loja, contrate um Parceiro da Shopify. Saiba mais sobre como contratar um Parceiro 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.

Apps personalizados que usam PII Nível 2

Com as permissões, é possível controlar os tipos de informações da loja que um app pode acessar ou modificar conforme a função realizada.

Informações de identificação pessoal (PII) são dados que sozinhos ou combinados podem identificar um indivíduo. Os apps que você instala da Shopify App Store podem acessar diferentes tipos de PII quando usam informações sobre a loja, os clientes, os pedidos ou outros dados comerciais. Para acessar apps personalizados que usam PII Nível 2, a loja precisa estar no plano Shopify ou uma opção superior.

Aviso

Se você se inscrever ou fizer downgrade de seu plano para o plano Basic Shopify ou o plano Shopify Starter, você não terá acesso aos apps PII (informações de identificação pessoal) do nível 2.

Ativar o desenvolvimento de apps personalizados no admin da Shopify

Antes de criar um app personalizado para sua loja, você precisa ativar o desenvolvimento de apps personalizados. Você precisa ser o titular da loja ou um membro da equipe com a permissão Habilitar o desenvolvimento de apps para ativar o desenvolvimento de apps personalizados.

Etapas:

1. No admin da Shopify, clique em Configurações > Apps e canais de vendas.

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 ativar o desenvolvimento de apps personalizados, é 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.

Dica

Se você precisar de ajuda na hora de criar apps personalizados para a loja, contrate um Parceiro da Shopify. Saiba mais sobre como contratar um Parceiro da Shopify.

Criar o app

1. No admin da Shopify, clique em Configurações > Apps e canais de vendas.

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

Depois de criar um app personalizado, você poderá atribuir escopos de API a ele. Um app personalizado pode ter escopos da API Admin, escopos da Storefront API ou de ambas, dependendo dos requisitos do app. Selecione pelo menos um escopo antes de instalar o app.

Aviso

A Storefront API é uma API pública não autenticada, ou seja, todos os dados expostos ao app podem ser vistos por qualquer visitante da loja. É importante estar ciente desse risco e lembrar de que é preciso dar permissões somente para os tipos de dados necessários para o app privado.

Etapas:

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.

Aviso

O token de acesso da API Admin é exibido apenas uma vez, porque o token fornece acesso da API a dados confidenciais do armazenamento. Depois da revelação do token de acesso, anote ou salve-o em um lugar seguro para poder consultá-lo de novo.

Trate o token como uma senha e o compartilhe somente com desenvolvedores de sua confiança.

Etapas:

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. Depois de revelar o token de acesso completo na primeira vez que esta página for acessada, ela exibirá apenas os últimos 4 dígitos do token de acesso para referência sobre visitas posteriores.
   • 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.

Localizar as credenciais da API de um app personalizado

Você pode verificar o token de acesso do Storefront, a chave de API e o segredo da API de um app personalizado na página credenciais da API. Também é possível verificar o token de acesso da API Admin, mas após revelá-lo na primeira vez que a página for acessada, você poderá verificar apenas os quatro últimos dígitos do token.

Observação

A chave secreta da API é igual a uma chave compartilhada. Se um desenvolvedor pedir uma chave secreta, forneça a chave da API. Lembre-se de compartilhar a chave secreta da API somente com desenvolvedores de confiança.

1. No admin da Shopify, clique em Configurações > Apps e canais de vendas.

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, clique em Configurações > Apps e canais de vendas.

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.

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

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

8. 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.

9. 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.

10. 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

Aviso

A Storefront API é uma API pública não autenticada, ou seja, todos os dados expostos ao app podem ser vistos por qualquer visitante da loja. É importante estar ciente desse risco e lembrar de que é preciso dar permissões somente para os tipos de dados necessários para o app privado.

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, clique em Configurações > Apps e canais de vendas.

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.

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

7. Opcional: se seu app for integrado ao kit de desenvolvimento de software (SDK) Buy para iOS, você poderá fazer as alterações necessárias na seção SDK Buy para iOS. 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.

8. 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.

9. 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, clique em Configurações > Apps e canais de vendas.

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 o Desenvolvedor principal do app.

7. Opcional: para notificar outro e-mail sobre atualizações de desenvolvimento do app, insira o endereço em Contato para atualização de desenvolvimento.

8. Clique em Salvar.

Desinstalar um app personalizado

Quando você desinstala um app personalizado, seus tokens de acesso às APIs Admin e Storefront são revogados, todos os webhooks e serviços de processamento de pedidos registrados no app são removidos, e o app não pode mais acessar os dados da loja. Se você reinstalá-lo, receberá novos tokens de acesso.

1. No admin da Shopify, clique em Configurações > Apps e canais de vendas.

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, clique em Configurações > Apps e canais de vendas.

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.