Documentação Visual — Parceirando

Manual do usuário · Lojista e Afiliado

Introdução

Sistema de afiliados voltado para gestão, visualização e pagamentos. Perfis: Lojista (gerencia afiliados e pedidos) e Afiliado (conversões, links, conta corrente). Blur aplicado apenas em campos sensíveis (LGPD).

Como usar este manual
  1. Use o menu lateral para navegar entre as telas.
  2. Cada card contém um Passo a passo explicando como acessar e usar a funcionalidade.
  3. As imagens são screenshots reais da plataforma (com blur em dados sensíveis).

🖥️ Desktop · Lojista

Painel de gestão de afiliados: dashboard, afiliados, pedidos, relatórios e configurações.

Dashboard

Rota: /

Página inicial com resumo e indicadores.

Passo a passo
  1. Faça login com seu e-mail e senha.
  2. Após autenticar, você será redirecionado automaticamente para o Dashboard.
  3. Visualize os cards de resumo (pedidos, afiliados, comissões) e gráficos de desempenho.
Dashboard

Nossos Apps

Rota: /apps

Acesso aos aplicativos da plataforma.

Passo a passo
  1. No menu lateral, clique em Nossos Apps.
  2. Visualize os aplicativos disponíveis (ex.: app lojista, app afiliado).
  3. Clique no card do app desejado para acessar o link de download ou mais informações.
Nossos Apps

Afiliados · Listar

Rota: /affiliate/list

Lista de afiliados cadastrados.

Passo a passo
  1. No menu lateral, expanda Afiliados (se necessário) e clique em Listar.
  2. Visualize a tabela com pedidos, aprovados, comissão, nome, data de afiliação e cupom.
  3. Use os botões Copiar, Excel ou PDF para exportar os dados.
  4. Use o campo de pesquisa (mín. 5 caracteres) para filtrar afiliados.
  5. Clique em Ações em uma linha para Visualizar, Editar, Pagamentos ou excluir.
Lista de Afiliados

Afiliados · Aceitar

Rota: /affiliate/accept

Afiliados pendentes de aprovação (solicitações). Diferente do Hub de Parceiros, onde você convida parceiros disponíveis.

Passo a passo
  1. No menu lateral, expanda Afiliados e clique em Aceitar.
  2. Visualize a lista de afiliados que solicitaram vínculo com sua loja.
  3. Clique em Aceitar para aprovar ou Recusar para negar o vínculo.
Afiliados Aceitar

Afiliados · Adicionar

Rota: /affiliate/create

Criar novo afiliado.

Passo a passo
  1. No menu lateral, expanda Afiliados e clique em Adicionar.
  2. Preencha os dados do afiliado (nome, e-mail, CPF, telefone, cupom etc.).
  3. Clique em Salvar para cadastrar o afiliado na sua loja.
Afiliados Adicionar

Hub de Parceiros

Rota: /affliate/global/dashboard

Encontre parceiros prontos para divulgar sua loja. Descubra criadores, afiliados e influenciadores alinhados ao seu nicho e solicite parceria com poucos cliques.

Passo a passo
  1. No menu lateral, expanda Hub de Parceiros e clique em Encontrar parceiros.
  2. Use a busca por nome, cidade ou nicho e, se quiser, ordene por sugeridos, nome ou mais redes sociais.
  3. Refine com filtros de rede social (Instagram, TikTok, YouTube, Facebook), perfil e nicho; clique em Aplicar filtros.
  4. No card do parceiro, clique em Ver perfil para conferir e-mail, região, nichos e redes.
  5. Clique em Convidar parceiro para adicioná-lo ao seu programa de afiliados, ou em Dispensar para ocultá-lo das próximas buscas.
  6. Se o seu plano permitir, use Convidar em massa para convidar vários parceiros de uma vez.
Dicas
  • A tela lista até 100 parceiros ainda não convidados por consulta.
  • Convidar consome vagas do seu plano — acompanhe o resumo no topo e no bloco do plano.
  • Em Comissão, habilite Participar do Hub de Parceiros para sua loja aparecer nessa rede.
  • O Hub é a camada de descoberta; por baixo continua o fluxo de afiliados.
Hub de Parceiros — busca e cards de parceiros

Pedidos · Listar

Rota: /order/list

Lista de pedidos da loja.

Passo a passo
  1. No menu lateral, expanda Pedidos e clique em Listar.
  2. Visualize a tabela de pedidos com status, afiliado, valor e comissão.
  3. Use filtros e pesquisa para encontrar pedidos específicos.
  4. Exporte para Excel ou PDF conforme necessário.
Pedidos Listar

Pedidos · Importar

Rota: /order/import

Importar pedidos da plataforma de e-commerce.

Passo a passo
  1. No menu lateral, expanda Pedidos e clique em Importar.
  2. Selecione a plataforma (ex.: WooCommerce, Shopify) ou faça upload de arquivo.
  3. Configure o mapeamento de campos (ID do pedido, cupom, valor etc.).
  4. Execute a importação e confira os pedidos na lista.
Pedidos Importar

Marcar Pedidos

Rota: /order/payment/list

Marcar pedidos para pagamento aos afiliados.

Passo a passo
  1. No menu lateral, expanda Pedidos e clique em Marcar Pedidos.
  2. Visualize os pedidos elegíveis para pagamento (com comissão aprovada).
  3. Selecione os pedidos que deseja marcar para pagamento.
  4. Confirme a marcação; os afiliados serão notificados e o valor ficará disponível na conta corrente.
Marcar Pedidos

Pedidos Marcados

Rota: /payment/list

Histórico de pagamentos realizados.

Passo a passo
  1. No menu lateral, clique em Pedidos Marcados (ou equivalente em Pagamentos).
  2. Visualize o histórico de pedidos já marcados para pagamento.
  3. Filtre por período, afiliado ou status conforme necessário.
Pedidos Marcados

Relatórios

Rota: /report/dashboard

Dashboard e gráficos de desempenho.

Passo a passo
  1. No menu lateral, clique em Relatórios.
  2. Visualize gráficos de vendas, comissões e desempenho por afiliado.
  3. Filtre por período e exporte relatórios se disponível.
Relatórios

Termo

Rota: /contract/create

Contratos e termos de uso.

Passo a passo
  1. No menu lateral, clique em Termo.
  2. Visualize ou edite o contrato/termo de afiliação da sua loja.
  3. Salve as alterações para que os afiliados vejam o termo atualizado.
Termo

Template e-mail

Rota: /site/create

Templates de e-mail para comunicação.

Passo a passo
  1. No menu lateral, clique em Template e-mail.
  2. Selecione o tipo de e-mail (boas-vindas, pedido marcado etc.).
  3. Edite o conteúdo usando as variáveis disponíveis (nome, link etc.).
  4. Salve para aplicar o template nas próximas comunicações.
Template e-mail

Planos

Rota: /plan/list

Planos e assinaturas.

Passo a passo
  1. No menu lateral, clique em Planos.
  2. Visualize os planos disponíveis e o status da sua assinatura.
  3. Clique em assinar ou alterar plano conforme necessário.
Planos

Metas

Rota: /meta/dashboard

Metas e objetivos de vendas.

Passo a passo
  1. No menu lateral, clique em Metas.
  2. Defina metas de vendas ou comissões por afiliado ou período.
  3. Acompanhe o progresso em relação às metas configuradas.
Metas

Comissão

Rota: /commission/create

Comissões padrão e em massa.

Passo a passo
  1. No menu lateral, clique em Comissão Padrão ou Comissão.
  2. Defina a porcentagem de comissão padrão para novos afiliados.
  3. Se quiser que sua loja apareça no Hub de Parceiros, habilite Participar do Hub de Parceiros.
  4. Use a opção de alterar em massa para ajustar comissões de afiliados existentes.
Comissão

Arquivos

Rota: /upload/files

Upload de materiais de divulgação.

Passo a passo
  1. No menu lateral, clique em Arquivos.
  2. Faça upload de banners, logos e materiais para os afiliados divulgarem.
  3. Organize por categorias e compartilhe os links com os afiliados.
Arquivos

Preferências

Rota: /account/profile/{id}

Configurações do perfil e tema escuro.

Como acessar
  1. No canto superior direito, clique no boneco (ícone do usuário).
  2. No menu que abrir, selecione Preferências.
O que configurar
  1. Altere senha, e-mail ou dados cadastrais conforme necessário.
  2. Ative o tema escuro na opção de aparência, se disponível.
Menu do usuário (boneco) com Preferências Tela Preferências

🖥️ Desktop · Afiliado

Perfil afiliado: conversões, links, conta corrente e afiliação.

Dashboard

Rota: //affiliate/dashboard

Página inicial com resumo e indicadores do afiliado.

Passo a passo
  1. Faça login com credenciais de afiliado.
  2. Após autenticar, visualize o Dashboard com suas métricas.
Dashboard Afiliado

Nossos Apps

Rota: /apps

Acesso aos aplicativos da plataforma.

Nossos Apps Afiliado

Conversões

Rota: /affiliate/conversion/list

Conversões e comissões geradas pelos links.

Passo a passo
  1. No menu lateral, clique em Conversões.
  2. Visualize as vendas geradas pelos seus links de afiliado.
Conversões

Conta Corrente

Rota: /bank/account/create

Conta bancária e saldo do afiliado.

Passo a passo
  1. No menu lateral, clique em Conta Corrente.
  2. Cadastre ou edite seus dados bancários para receber pagamentos.
Conta Corrente

Pedidos · Listar

Rota: /order/list

Lista de pedidos vinculados ao afiliado.

Pedidos Listar Afiliado

Pedidos Marcados

Rota: /payment/list

Histórico de pagamentos realizados.

Pedidos Marcados Afiliado

Afiliação

Rota: /affiliation/dashboard

Dashboard de afiliação e lojas vinculadas.

Afiliação

Meus Dados

Rota: /affiliate/me/{id}

Dados cadastrais do afiliado (nome, e-mail, nichos e redes sociais).

Como acessar
  1. No canto superior direito, clique no boneco (ícone do usuário).
  2. No menu que abrir, selecione Meus Dados.
Hub de Parceiros
  1. Preencha perfil, nichos e redes sociais para ficar mais fácil de ser encontrado.
  2. Habilite Participar do Hub de Parceiros para que lojistas possam convidar você a divulgar as lojas deles.
Menu do usuário (boneco) com Meus Dados Tela Meus Dados

Preferências

Rota: /account/profile/{id}

Configurações do perfil e tema.

Preferências

Tour em Vídeo

Gravações geradas automaticamente: npm run video:all.

Tour completo · Lojista

Vídeo contínuo percorrendo todas as telas do perfil lojista.

Tour completo · Afiliado

Vídeo contínuo percorrendo todas as telas do perfil afiliado.