A API da Martz permite que outros sistemas da sua empresa (um formulário externo, um CRM, uma planilha automatizada, um sistema próprio) leiam e enviem dados para a sua conta Martz. Veja onde gerar a chave de acesso, onde fica a documentação e o que dá para fazer.
Antes de começar
Se a sua loja ou ERP já tem integração nativa com a Martz (por exemplo Nuvemshop, Shopify, Tray, WooCommerce, Yampi, Bling, Omie ou Tiny), confira primeiro em Configurações > Integrações. Nesses casos, não é preciso usar a API.
Como gerar a chave
Passo 01 — Abra Chaves de Acesso
No menu, abra Configurações e, em Desenvolvedor, clique em Chaves de Acesso.
Passo 02 — Gere e copie a chave
No quadro Chave da API pública, clique em gerar nova chave e copie a chave. Ela identifica a sua loja: todas as chamadas feitas com ela acessam somente os dados dessa loja.
⚠️ Gerar uma nova chave invalida a anterior. Antes de confirmar, garanta que você vai atualizar a chave em todos os sistemas que acessam a sua API. Guarde a chave com segurança e não a compartilhe em canais públicos.
Passo 03 — Entregue a chave e a documentação ao time técnico
Clique em Documentação da API, na mesma tela, ou acesse martz-api-docs.readme.io. Lá estão todas as instruções técnicas, campos e exemplos para o desenvolvedor.
O que dá para fazer pela API
Enviar clientes e leads: cadastrar ou atualizar contatos vindos de um formulário ou landing page externa. Se o contato já existe (mesmo e-mail, telefone ou documento), ele é atualizado em vez de duplicado.
Enviar pedidos, produtos e categorias: para lojas sem integração nativa.
Gerenciar tags e anotações de clientes.
Inscrever clientes em fluxos e registrar eventos personalizados, que podem disparar fluxos e campanhas.
Consultar dados: clientes, grupos, pedidos, carrinhos abandonados, bônus, campanhas e seus resultados, atividades, pop-ups e seus assinantes, dashboards e números e modelos de WhatsApp.
Leads de uma página externa
Para levar os leads de um formulário fora da Martz, há dois caminhos:
Planilha (em lote): em Clientes, importe a planilha modelo. Veja Importação de clientes.
API (automático): o seu formulário envia cada lead para a Martz no momento do cadastro. O contato entra habilitado e pode receber campanhas. Peça ao seu desenvolvedor para usar a chave e seguir a documentação.
URLs de notificações
Para algumas integrações, a tela Chaves de Acesso também mostra o quadro URLs de notificações, com os endereços que a plataforma integrada usa para avisar a Martz sobre novidades da sua loja. Copie a URL quando o passo a passo da integração pedir.
Quero receber avisos da Martz no meu sistema
Para o seu sistema ser avisado quando algo acontece na Martz (cliente cadastrado, pesquisa respondida, bônus usado etc.), use os webhooks. Veja Webhooks: receba avisos da Martz no seu sistema.