O programa de Parceiros Tech da Yampi simplifica a criação, a integração e a gestão de aplicativos que otimizam operações e impulsionam vendas. Oferecemos uma plataforma segura e intuitiva, com autonomia para o desenvolvedor do planejamento até a publicação na nossa Loja de Aplicativos.
Neste artigo, reunimos tudo o que você precisa para tirar o aplicativo do papel: da criação no painel até a publicação na Loja.
Neste artigo, vamos mostrar:
Para acessar o painel, é necessário ter uma conta de parceiro ativa. Se você ainda não tem, crie a sua em partners.yampi.com.br.
Como criar um aplicativo?
Depois de criar o aplicativo, siga as etapas de configuração e publicação. Elas ficam reunidas no bloco Etapas até a publicação, na página do app.
Passo 1 — Acesse o Painel de Parceiro Tech.
Passo 2 — No menu lateral ou na página inicial, clique em Meus aplicativos.
Passo 3 — Clique em + Novo aplicativo.
Passo 4 — Preencha os dois campos obrigatórios:
Nome do aplicativo: é assim que ele aparece na Loja de Aplicativos.
Categoria do aplicativo: selecione a categoria que melhor representa a solução.
Passo 5 — Clique em Criar aplicativo. Você segue para a página do aplicativo, que nasce com o status Em desenvolvimento.
Quais categorias estão disponíveis?
Categoria | Descrição |
Análise | Apps para conectar a operação Yampi a ferramentas de análise de dados |
Canais de venda | Apps para conectar a Yampi a outras plataformas de venda |
Comunicação | Apps para atender o cliente em diferentes etapas da venda |
Dropshipping | Apps específicos para operações de dropshipping |
Gestão | Apps para diferentes etapas de gerenciamento da operação |
Logística | Apps de frete, cotação, envio e demais ações de logística |
Marketing | Apps para gerar engajamento de leads e clientes |
Pagamentos | Apps para facilitar a gestão e análise de pagamentos da operação |
Segurança | Apps para melhorar a segurança e verificação de antifraude |
Outra categoria | Selecione se o seu app não se encaixar em nenhuma categoria |
📌 Importante: ao selecionar a categoria Pagamentos, o painel exibe um aviso informando que não é possível criar aplicativos de gateway de pagamento na Loja da Yampi.
A categoria pode ser alterada depois, na página do aplicativo.
Quais são as etapas até a publicação?
A página do aplicativo reúne, no bloco Etapas até a publicação, o caminho completo do app. Cada etapa fica verde conforme você a conclui, e as legendas são clicáveis:
Etapa | O que fazer | Quando fica concluída |
1. Configurar o aplicativo | Cadastrar a URL de redirecionamento e selecionar as permissões de API | Ao salvar as configurações pela primeira vez |
2. Informações da página | Preencher a página do aplicativo, que é o que o lojista vê na Loja | Ao salvar as informações pela primeira vez |
3. Enviar para análise | Submeter o app para a validação da Yampi | Quando a análise é concluída |
4. Publicar na Yampi | Publicar o app aprovado na Loja de Aplicativos | Quando o app é publicado |
Além do bloco de etapas, a página do aplicativo reúne cards de acesso rápido:
Seções | Para que serve |
Status do aplicativo | Verificar e gerenciar os status do seu aplicativo na Loja da Yampi |
Testar aplicativo | Instalar o aplicativo em uma loja teste enquanto desenvolve |
💡 Dica: testar o aplicativo em uma loja teste não é uma etapa , mas continua sendo parte essencial do processo. Veja a seção Como testar o aplicativo?
Como configurar a API e as permissões?
Esta é a Etapa 1. Na página do aplicativo, clique em Configurar o aplicativo para abrir a página Configurações de API e permissionamento.
Credenciais do aplicativo
Credenciais do aplicativo
O App Alias e o Client ID ficam visíveis no cabeçalho da página do aplicativo e podem ser copiados com um clique.
📌 Importante: o App Alias é gerado no momento da criação do aplicativo e não pode ser alterado depois. |
URL de redirecionamento
URL de redirecionamento
Depois que o lojista autoriza o aplicativo, a Yampi o redireciona para essa URL com um código de autorização temporário. Ela é obrigatória para que a integração OAuth funcione.
Você pode utilizar uma URL localhost enquanto o aplicativo não estiver publicado.
Para a publicação, a URL precisa utilizar o protocolo HTTPS.
Mantenha a URL sempre válida, independentemente da versão do app, para que a instalação continue funcionando.
Permissões do aplicativo
Permissões do aplicativo
Selecione as permissões que o aplicativo precisa na loja do cliente. O painel exibe um contador com o total de permissões selecionadas e o contexto de cada rota da API.
As permissões definem o que a integração consegue acessar. Por exemplo: para consumir informações de pedidos, é necessário marcar as permissões relacionadas a pedidos. Sem isso, a rota não funciona.
⚠️ Atenção: selecione apenas as permissões que o aplicativo realmente utiliza. Permissões em excesso sem justificativa são um dos principais motivos de recusa na análise. Confira os critérios em Diretrizes para aplicativos na Yampi
Como preencher a página do aplicativo?
Esta é a Etapa 2, chamada Informações da página. Tudo o que você preenche aqui é o que o lojista vê na Loja de Aplicativos. O formulário é dividido em duas abas.
Informações
Informações
Informações do aplicativo
Campo | Preenchimento | Observações |
Nome do aplicativo | Obrigatório | Aparece assim na Loja de Aplicativos |
Alias | Automático | Gerado na criação e não editável |
Categoria | Obrigatório | Lista atualizada conforme o catálogo da Yampi |
Site do aplicativo | Opcional | URL do site da sua solução |
Resumo | Obrigatório | Descrição curta do que o app faz, com no máximo 62 caracteres |
Descrição | Obrigatório | Mínimo de 180 caracteres. Descreva o que o app faz e seus diferenciais |
Link de gerenciamento | Opcional | Site onde o lojista configura o aplicativo. É o destino do botão Gerenciar na página do app |
Logotipo
Formato PNG ou JPEG, dimensão de 512x512 pixels e até 2 MB. O logotipo é obrigatório para publicar o aplicativo.
Mídias do aplicativo
Adicione até 8 imagens ou vídeos para mostrar o aplicativo em funcionamento. Eles aparecem em um carrossel no topo da página do app na Loja.
Ao subir uma imagem, o painel abre um editor de recorte.
Para vídeos, informe a URL de um vídeo hospedado no YouTube.
As mídias podem ser reordenadas.
📌 Importante: as mídias do aplicativo estão disponíveis para apps OAuth criados pelo Painel de Parceiro Tech.
Documentação de ajuda
Campo | Preenchimento | Observações |
URL de artigo tutorial | Opcional | Link do artigo na sua central de ajuda |
URL de vídeo tutorial | Opcional | Vídeo hospedado no YouTube |
Funções do aplicativo
Liste o que o lojista consegue fazer com o seu aplicativo. Cada função aceita até 240 caracteres, e é necessário cadastrar pelo menos uma.
Planos e Preços
Planos e Preços
Nesta aba, você informa como o aplicativo é cobrado. É possível cadastrar até 6 planos.
Campo | O que informar |
Aplicativo gratuito | Marque se o app não tem cobrança |
Tipo de precificação | Grátis, Mensalidade ou Sob consulta |
Funcionalidades do plano | O que está incluso, com até 1400 caracteres |
Teste grátis | Sinalize se o plano tem período de teste e quantos dias |
Link para a página de planos | Endereço da sua página de preços |
Os planos podem ser reordenados, duplicados e excluídos. Saiba mais em Planos e preços no App
⚠️ Atenção: não é possível criar ou editar planos enquanto o aplicativo estiver com o status Em análise.
Checklist Otimize sua página
Ao lado do formulário, o painel exibe o checklist Otimize sua página, que acompanha o preenchimento dos itens que mais influenciam a decisão do lojista: site, URL de artigo tutorial, URL de vídeo tutorial, preços e mídias.
Enquanto houver item pendente, o card do aplicativo exibe a tag Não otimizado. Ao concluir todos, o checklist mostra a mensagem Página otimizada!.
Para entender como cada campo aparece na Loja, confira Como funciona o gerenciamento de informações do aplicativo? e Como inserir imagens e vídeos na página do aplicativo?
Como testar o aplicativo?
Antes de enviar o app para análise, instale-o em uma loja teste: um painel Yampi criado só para validação, no qual você confere o fluxo de autorização OAuth e o comportamento das permissões sem impactar uma loja real.
Na página do aplicativo, clique no bloco Testar aplicativo. Se você ainda não tem uma loja teste, o painel abre a modal de criação. Cada parceiro pode criar até 5 lojas teste.
📌 Importante: apenas aplicativos com o status Em desenvolvimento podem ser instalados em uma loja teste, e é necessário ter cadastrado antes a URL de redirecionamento.
Confira o fluxo completo, as regras da loja teste e as dúvidas frequentes em Como testar um aplicativo?
Como enviar para análise e publicar?
Com as etapas 1 e 2 concluídas e o aplicativo testado, clique em Enviar para análise na página do aplicativo.
Na tela de envio, é necessário informar:
Documentação para análise: link do vídeo ou do artigo tutorial de instalação e uso do app.
Escopo de permissões de API: justificativa de cada permissão solicitada, com no mínimo 100 caracteres.
Você também pode enviar credenciais de teste da sua plataforma, o que agiliza a análise.
Depois da aprovação, clique em Publicar para disponibilizar o aplicativo na Loja. A exibição na Loja de aplicativos pode levar alguns minutos.
Os passos detalhados estão em Como enviar aplicativo para análise? e Como publicar um aplicativo na Loja de Apps da Yampi?
Como visualizar e editar um aplicativo depois de publicado?
Para visualizar e editar os dados do aplicativo a qualquer momento:
Passo 1 — Acesse o Painel de Parceiro Tech.
Passo 2 — Clique em Meus aplicativos.
Passo 3 — Selecione o aplicativo que deseja visualizar.
Passo 4 — Clique em Informações da página para editar os dados.
Com o aplicativo publicado, o comportamento da edição depende do que você altera:
O que você edita | O que acontece |
Dados da página do app: nome, logotipo, categoria, descrição, resumo, site, mídias, vídeo, funcionalidades, planos e preços | A alteração é publicada automaticamente, em tempo real, sem passar por análise |
Credenciais, permissões de API e URL de redirecionamento | Uma nova versão é criada e enviada para análise. A versão publicada continua ativa para os lojistas até você publicar a nova |
📌 Importante: quando uma nova versão altera as permissões do aplicativo, os lojistas que já têm o app instalado precisam instalar a nova versão.
O passo a passo do versionamento está em Como atualizar meu aplicativo publicado na Loja de Apps da Yampi?
Quais são os status do aplicativo?
Status | O que significa | O que é possível fazer |
Em desenvolvimento | Aplicativo criado, ainda não enviado para análise | Editar livremente e instalar em loja teste |
Em análise | Enviado para análise de negócio e homologação da integração | Aguardar o retorno. Os formulários ficam bloqueados |
Aprovado | Aprovado para publicação na Loja de Aplicativos | Publicar. Se editar antes de publicar, o app volta para Em desenvolvimento |
Não aprovado | Não aprovado para publicação | Ajustar conforme o feedback da análise e reenviar |
Publicado | Disponível na Loja de Aplicativos | Editar conforme as regras da seção anterior |
Dúvidas frequentes 🤔
▶️ Clique na seta para visualizar o conteúdo
Posso criar um aplicativo de gateway de pagamento?
Posso criar um aplicativo de gateway de pagamento?
Não é possível publicar aplicativos de gateway de pagamento na Loja da Yampi. Ao selecionar a categoria Pagamentos, o painel exibe esse aviso. A categoria atende apps que facilitam a gestão e a análise de pagamentos da operação.
Não encontrei a categoria do meu aplicativo. O que fazer?
Não encontrei a categoria do meu aplicativo. O que fazer?
Selecione Outra categoria e nos escreva para [email protected] contando qual categoria faria sentido para a sua solução.
Por que meu aplicativo foi reprovado na análise?
Por que meu aplicativo foi reprovado na análise?
Os motivos mais comuns são: permissões de API além do necessário e sem justificativa por escopo; URL de redirecionamento com falha; informações do app fora do português; aplicativo enviado antes de a integração OAuth estar concluída; credenciais de teste inválidas, vídeo demonstrando outra plataforma e etc.
O feedback específico da sua análise fica disponível no painel. Revise os critérios em Diretrizes para aplicativos na Yampi
Consigo editar o aplicativo enquanto ele está em análise?
Consigo editar o aplicativo enquanto ele está em análise?
Durante a análise, os formulários ficam bloqueados e nenhum dado pode ser editado. Assim que a análise for concluída, a edição é liberada.
Meu app está com a tag "Não otimizado". Isso impede a publicação?
Meu app está com a tag "Não otimizado". Isso impede a publicação?
Não. A tag indica que ainda há itens do checklist Otimize sua página por preencher, como mídias, preços ou tutoriais. Eles não bloqueiam a publicação, mas ajudam o lojista a entender a sua solução e a decidir pela instalação.
Posso alterar o alias do aplicativo?
Posso alterar o alias do aplicativo?
O alias é gerado no momento da criação e não pode ser alterado depois. Os demais dados, incluindo o nome, podem ser editados.
Onde vejo o histórico de alterações do meu aplicativo?
Onde vejo o histórico de alterações do meu aplicativo?
Na página de status do aplicativo, no Painel de Parceiro Tech, você acompanha as versões criadas e o que mudou em cada uma.
Em caso de dúvidas, você pode nos encaminhar um e-mail para [email protected].