Este artigo explica, em um tutorial guiado, como obter as credenciais de API na Yampi e inseri-las na Martz para concluir sua integração.
Obtendo as credenciais na Yampi
Para integrar sua loja com a Martz, você precisará de três credenciais disponíveis no painel da Yampi: Alias, Token e Chave Secreta.
⚠️ Atenção: Proteja suas credenciais. Não compartilhe o Token e a Chave Secreta com terceiros. Essas informações são de uso exclusivo para integrações autorizadas.
Importante: Apenas o proprietário ou administradores da loja na Yampi possuem acesso à área de credenciais de API. Caso você não tenha esse nível de acesso, solicite ao proprietário da loja.
Siga os passos abaixo para obter as credenciais:
Passo 01 — Acesse as Credenciais de API
Faça login no painel da Yampi.
No canto superior direito da tela, clique no ícone do seu perfil/loja.
No menu que se abrirá, clique em Credenciais de API.
Passo 02 — Copie as credenciais
Na tela de credenciais, você verá três informações:
Alias — Identificador único da sua loja (não pode ser alterado). Funciona como o "RG" da sua conta na Yampi.
Token — Token de autenticação da API.
Chave Secreta (Secret Key) — Chave secreta utilizada para validar a comunicação.
Copie essas três informações. Elas serão necessárias na próxima etapa.
Dica: As credenciais da Yampi (Token e Chave Secreta) são globais da loja e não possuem seleção de permissões por escopo — diferente de outras plataformas. Ao obtê-las, a integração terá acesso aos recursos necessários automaticamente (pedidos, clientes, produtos, carrinhos abandonados, etc.).
Integrando com a Martz
Com as credenciais em mãos, siga para o painel da Martz e finalize a integração:
Acesse o Painel da Martz e faça login na sua conta.
Clique no seu nome de usuário no canto superior direito da tela.
Acesse Configurações → Integrações.
Na seção de E-commerces, localize a Yampi e clique em Integrar.
No modal que se abrirá, preencha os campos com as credenciais obtidas na Yampi:
Alias — cole o Alias copiado.
Token — cole o Token copiado.
Chave Secreta — cole a Chave Secreta copiada.
Clique em Criar integração.
Pronto, sua integração está completa! ✅
Agora é só aguardar que a Martz começará a sincronizar as informações da sua loja. Essa sincronização pode demorar até 1 hora para ser iniciada. O tempo de término vai depender do tamanho da base da sua loja.
⚠️ Atenção: A API da Yampi possui limitações no tamanho de resposta por requisição. Por esse motivo, a sincronização da base histórica é feita dia a dia. Para lojas com um histórico muito extenso (ex.: desde 01/01/2024 até hoje), o processo pode levar mais tempo do que o habitual. Se perceber lentidão ou falhas na sincronização, entre em contato com o nosso suporte.
Configuração de Webhooks
Etapa muito importante para melhor eficiência na comunicação com sua loja Yampi!
Esta etapa deverá ser realizada após a integração da loja com a Martz, conforme etapas anteriores deste tutorial.
Os webhooks permitem que a Yampi notifique a Martz automaticamente quando um evento ocorrer na sua loja (uma nova venda, atualização de pedido, carrinho abandonado, etc.), garantindo uma sincronização mais rápida e eficiente.
Para configurar:
No painel da Martz, acesse Configurações → Chaves de acesso e copie a URL de webhook disponibilizada.
No painel da Yampi, acesse Configurações → Webhooks.
Clique em + Novo webhook.
Preencha os campos:
Nome: Martz
URL: cole a URL de webhook copiada da Martz
Selecione os eventos que deseja monitorar. Os principais recomendados são:
Pedido Criado
O status de um pedido foi atualizado
Carrinho abandonado
Clique em Salvar.
🎉 Pronto! Agora a Yampi notificará a Martz em tempo real sobre os eventos configurados, garantindo que seus dados estejam sempre atualizados.