Passar para o conteúdo principal

Diretrizes para aplicativos na Yampi

Confira os critérios de qualidade e segurança que os aplicativos precisam seguir para serem publicados na Loja de Aplicativos da Yampi.

A Loja de Aplicativos da Yampi é um espaço dedicado a soluções que ampliam e fortalecem as possibilidades do lojista dentro da plataforma. Para garantir uma experiência segura, eficiente e de qualidade para todos, os apps precisam seguir um conjunto de diretrizes técnicas e de conteúdo.

Neste artigo, você confere os critérios necessários para que um aplicativo seja publicado e permaneça disponível na Loja da Yampi:

Funcionalidades e política de conteúdo

  • Relevância: O app deve oferecer funcionalidades úteis e alinhadas às necessidades dos lojistas.

  • Qualidade da Experiência: O app deve ser fácil de usar, com uma interface clara e sem bugs.

  • Valor Adicionado: O app deve complementar ou expandir as capacidades da Yampi.

  • Uso Ético: O app não deve promover práticas antiéticas ou violar leis aplicáveis.

  • Idioma: todos os textos e vídeos do aplicativo, incluindo descrição, tutoriais e mídias, devem estar em português do Brasil e demonstrar o app funcionando na Yampi.

Compatibilidade e qualidade técnica

A integração técnica entre o app e a Yampi precisa ser segura e bem estruturada. Por isso, os critérios incluem:

  • Uso correto das APIs: é necessário seguir a documentação oficial da Yampi e utilizar as APIs e SDKs da forma adequada.

  • Performance estável: o app não pode causar lentidão, travamentos ou instabilidades na loja.

  • Ambiente de testes: todo aplicativo deve ser testado previamente em uma loja teste da Yampi. A instalação em ambiente teste está disponível para apps com o status Em desenvolvimento. Veja o passo a passo em Como testar um aplicativo?

  • Código limpo e bem documentado: boas práticas de desenvolvimento são indispensáveis, como organização e comentários no código.

Suporte e manutenção

A responsabilidade sobre o funcionamento do app também faz parte das diretrizes:

  • Documentação clara: o parceiro tech deve fornecer guias de uso e suporte técnico.

  • Atendimento ao lojista: é fundamental estar disponível para ajudar os lojistas e o time da Yampi sempre que surgirem dúvidas ou problemas.

  • Manutenção contínua: o app deve ser mantido em pleno funcionamento, com correções e melhorias contínuas.

Segurança

A proteção dos dados dos lojistas é prioridade. Por isso, os apps devem seguir padrões rígidos de segurança:

  • Conformidade com a LGPD: é obrigatório seguir a legislação vigente sobre proteção de dados.

  • Sem código malicioso: o app deve ser livre de qualquer tipo de malware.

  • Autenticação segura: o uso de OAuth 2.0 é obrigatório.

  • Tráfego seguro: todo tráfego de dados precisa ser criptografado com SSL/TLS, em versões seguras.

  • Princípio do menor privilégio: o app só pode solicitar permissões realmente necessárias, e deve justificá-las.

  • Incidentes de segurança: em caso de falhas ou vazamentos, o parceiro deve comunicar a Yampi com total transparência e agilidade.

⚠️Atenção: Apps que violarem qualquer uma dessas diretrizes podem ser removidos da Loja de aplicativos da Yampi. O objetivo é manter um ecossistema seguro, estável e confiável para todos os usuários da plataforma.

Dúvidas frequentes 🤔

▶️ Clique na seta para visualizar o conteúdo

Meu app só consome webhooks e não acessa a API. Preciso mesmo de OAuth 2.0?

Sim. O OAuth 2.0 é obrigatório para que o app seja exibido na Loja de Apps, mesmo que ele tenha poucas funções ou apenas consuma nossos webhooks. Inclusive, o recomendado é já configurar os webhooks no momento da instalação: assim, quando o lojista instala o app, todas as configurações necessárias são feitas automaticamente na conta Yampi dele.

Marquei a permissão “Gerenciar”. Ela já inclui “Visualizar”?

Não. As permissões são independentes: se o seu app precisa ler e alterar um recurso, marque as duas — por exemplo, Catálogo · Visualizar e Catálogo · Gerenciar. Lembrando que vale o princípio do menor privilégio: solicite apenas o que o app realmente usa e justifique cada permissão.

A URL de redirecionamento pode apontar para localhost?

Não. A URL precisa ser segura (HTTPS) e não pode ser local — nada de localhost, 127.0.0.1 ou similares.

Preciso testar o app antes de enviar para análise?

Sim, o teste em loja teste é obrigatório. Você pode criar até 5 lojas teste no seu Painel de Parceiro Tech e validar o app em um ambiente seguro. Veja o passo a passo em Como testar um aplicativo?

Meu app pode ter conteúdo em inglês?

Não. Todos os textos e vídeos do aplicativo — descrição, tutoriais e mídias — devem estar em português do Brasil e demonstrar o app funcionando na Yampi.

Se você é parceiro tech e tem dúvidas sobre essas diretrizes, fale com nosso time pelo e-mail [email protected]. Estamos aqui para apoiar você na construção de soluções incríveis para os lojistas da Yampi! 😉

Respondeu à sua pergunta?