Este é o guia completo para os desenvolvedores que desejam integrar ferramentas externas no Checkout ou à Loja virtual da Yampi, fornecendo todas as informações necessárias para facilitar o processo de integração.
Neste artigo mostraremos como funciona o processo de integração, documentações necessárias e muito mais!
⚠️ Importante: Se você tem uma integração com a Yampi e deseja incluí-la em nosso catálogo de aplicativos avance para o Processo de aprovação.
Documentação Disponível
Através dessa API REST você conseguirá administrar todos os recursos que uma loja possui dentro do nosso ambiente.
Ambiente de Testes
Atualmente nosso ambiente de testes é dedicado a parceiros. Para obter acesso é necessário entrar em contato com o time de Parcerias através do e-mail [email protected] e verificar a disponibilidade.
Suporte Técnico
Nosso suporte esta preparado para receber dúvidas técnicas relacionadas a nossa API. Caso possua alguma dúvida ou problema técnico, entre em contato através dos nossos canais de atendimento.
Publicação no Catálogo de Apps
Caso a integração cumpra com os requisitos citados no Processo de aprovação, a mesma pode ser adicionada ao catálogo da Yampi no modelo de integração externa, que consiste em disponibilizar um link direto para a página de autenticação do fornecedor do aplicativo. Para isso é necessário que a empresa desenvolvedora nos envie os seguintes dados:
Titulo do App;
Breve descrição (até 120 caracteres);
Link de acesso;
Ícone da marca em "svg";
Categoria do APP;
Instrução/Artigo/Vídeo tutorial de como é feita a integração;
Oferta fixa para ser oferecida a nossa base.
Ações de Marketing
Nosso time de Parcerias está disponível para alinhar ações de marketing em conjunto com empresas fornecedoras de ferramentas que integram com a Yampi. Para verificar a possibilidade de produzirmos materiais, ações e webinars em conjunto, entre em contato pelo e-mail [email protected].
Políticas e Termos
Ao integrar sua ferramenta com nossa plataforma, é fundamental compreender e concordar com nossas políticas e termos estabelecidos. Estas diretrizes garantem a conformidade com padrões éticos e técnicos:
Manutenção e Atualização: Esperamos que as ferramentas integradas se comprometam a manter seus sistemas atualizados, corrigindo eventuais bugs e garantindo a compatibilidade contínua.
Suporte Técnico: Integradores devem oferecer suporte técnico adequado aos usuários finais, respondendo a dúvidas e solucionando problemas relacionados à integração.
Transparência: Incentivamos total transparência quanto às práticas comerciais, garantindo que os usuários finais tenham uma compreensão clara de como suas informações são utilizadas.
Ambiente de teste: O integrador não deve utilizar o ambiente de testes para atividades comerciais para beneficio próprio, como vender produtos e serviços reais.
Feedback e Melhorias
O integrador poderá fornecer qualquer feedback e sugestão de melhoria em relação ao processo de integração em [email protected].
📢 Atenção: Você desenvolveu uma integração e quer fazer parte do ecossistema de aplicativos da Yampi? Clique no botão abaixo 👇
Dúvidas frequentes 🤔
▶️ Clique na setinha de cada um para abrir o conteúdo*
Como ser um parceiro da Yampi e publicar uma integração em nosso catálogo?
Como ser um parceiro da Yampi e publicar uma integração em nosso catálogo?
Caso você tenha desenvolvido uma integração com a Yampi e queira publicá-la em nosso catálogo, preencha esse formulário de contato também presente ao final do artigo. Nosso time de parcerias entrará em contato o mais breve possível solicitando as informações necessárias para o processo de aprovação.
Como funciona o processo de aprovação?
Como funciona o processo de aprovação?
Nosso time de Ecossistema de Parcerias é responsável por realizar alguns testes antes de incluir a integração ao nosso catálogo de aplicativos. Para isso é necessário que a empresa desenvolvedora compartilhe conosco uma conta de testes na ferramenta/plataforma integrada, que possua o acesso a todas as funções integradas com a Yampi liberado.
O time irá realizar o processo de autenticação da integração, além de testar o funcionamento das features integradas a fim de validar se todas estão funcionando como esperado, pois é importante asseguramos que o aplicativo adicionado ao nosso catálogo não irá oferecer uma má experiência de uso a nossa base.
Quais são os critérios para uma integração ser aprovada?
Quais são os critérios para uma integração ser aprovada?
No processo de aprovação o time avalia se a integração cumpre com o que é proposto e, se todas as features integradas funcionam corretamente conforme especificado nos materiais e artigos do fornecedor. Também avaliamos se a integração não expõe indevidamente dados sensíveis dos usuários da Yampi, se não oferece uma má experiência de uso como telas e links quebrados ou instabilidade de fornecimento de algum serviço.
Em caso de dúvidas, encaminhe um e-mail para [email protected] e aguarde o retorno da nossa equipe😉