Documentação
Começar
GUIA DO PAINEL

Documentação do painel

Guias práticos para administrar sua loja, acompanhar a operação e conectar suas aplicações com segurança.

A documentação reúne orientações práticas para administrar produtos, pedidos, clientes e configurações da loja. Para começar, siga a sequência recomendada abaixo e use a navegação lateral para consultar cada área.

Já sabe o que procura? Use a busca no topo para encontrar uma seção, recurso ou mensagem de erro.

Coloque sua loja em operação

Se você está começando, esta ordem ajuda a preparar o painel antes de receber pedidos.

1

Revise a identidade e as configurações

Defina as informações públicas da loja, domínio e template em Configurações.

Configurações da loja ›
2

Organize o catálogo

Cadastre produtos e categorias, confira nomes, preços e a forma de entrega de cada item.

Produtos e categorias ›
3

Configure o recebimento

Conecte o gateway disponível para sua loja e revise os dados de configuração antes de ativar.

Financeiro e gateways ›
4

Acompanhe os primeiros pedidos

Confira o status das vendas e valide se pagamentos aprovados aparecem corretamente no painel.

Vendas e pedidos ›

Área de trabalho

O painel reúne os indicadores e atalhos da loja selecionada. Antes de conferir números ou editar dados, verifique o seletor de loja no menu lateral para ter certeza de que está no contexto correto.

i

Os dados são separados por loja. Ações e relatórios exibidos correspondem à loja ativa e às permissões da sua conta.

Lojas

Use o seletor do menu lateral para alternar entre as lojas às quais sua conta tem acesso. O painel carrega o contexto da loja escolhida; confira o nome exibido antes de realizar alterações.

  • Administradores podem consultar lojas de usuários pela área específica de lojas dos usuários.
  • Usuários comuns veem apenas as lojas vinculadas à própria conta.
  • Uma loja já associada à conta continua disponível após sair e entrar novamente.

Produtos e categorias

Cadastre itens no catálogo da loja e organize-os em categorias para facilitar a navegação. Revise nome, descrição, preço, disponibilidade e os detalhes de entrega antes de publicar.

!

Confira os dados antes de ativar. Alterações no catálogo podem aparecer para os clientes da loja.

Vendas e pedidos

Consulte pedidos, clientes, valores e o estado de cada pagamento. A receita confirmada considera pagamentos aprovados; pedidos pendentes, expirados ou cancelados não devem ser tratados como receita recebida.

Se um pagamento aprovado não aparecer, confira o período selecionado, a loja ativa e o estado retornado pelo gateway.

Clientes

Os perfis de clientes são formados a partir dos checkouts e pedidos registrados para a loja. Use a busca para localizar um perfil e conferir o histórico relacionado.

Financeiro

Configure os gateways disponíveis e acompanhe vendas, pagamentos e valores processados. As credenciais de pagamento devem ser guardadas apenas no formulário protegido do painel, nunca em páginas públicas ou scripts do navegador.

Configurações

As opções são aplicadas à loja ativa. A área inclui identidade da loja, domínio, template e integrações. Confirme o contexto da loja antes de salvar.

Chaves de API

As chaves são vinculadas a uma única loja e permitem consultar somente o resumo do dashboard. Elas não concedem acesso ao painel administrativo nem a outras lojas.

Crie uma chave

  1. No painel, selecione a loja desejada.
  2. Acesse Configurações → Integrações → Chaves de API.
  3. Crie uma chave com um nome que identifique a aplicação e copie o segredo exibido. Ele não será mostrado novamente.
  4. Guarde a chave em um gerenciador de segredos e use-a somente no servidor da sua aplicação.

Consulte o resumo do dashboard

O endpoint usa GET e aceita a chave no cabeçalho Authorization: Bearer. Faça as chamadas no servidor da sua aplicação; não exponha a chave no navegador.

GEThttps://api.baratokeys.com.br/v1/integrations/dashboardSomente leitura · uma loja
curl --request GET \
  --url https://api.baratokeys.com.br/v1/integrations/dashboard \
  --header "Authorization: Bearer SUA_CHAVE"

Exemplo de resposta

{
  "store": { "id": "…", "slug": "minha-loja", "name": "Minha loja" },
  "dashboard": {
    "total_orders": 42,
    "paid_orders": 30,
    "pending_orders": 4,
    "revenue_cents": 259900,
    "total_products": 12
  }
}

Valores monetários são retornados em centavos. A chave não libera rotas administrativas, dados individuais de clientes nem acesso a outra loja.

i

Respostas de autenticação: chave ausente, inválida ou revogada retorna 401 API_KEY_INVALID. Uma loja indisponível retorna 404 STORE_NOT_FOUND.

!

Se uma chave for exposta, revogue-a imediatamente em Configurações → Integrações e gere outra.

Webhooks

O painel permite cadastrar um endpoint HTTPS e selecionar eventos. Os eventos disponíveis na configuração são:

order.createdorder.approvedorder.cancelledorder.refundedstock.out_of_stockcustomer.created
!

Limite desta documentação: o contrato público de entrega — formato do payload, assinatura, tentativas e garantias — ainda não está especificado. Não dependa desses envios em produção sem validar esse contrato.

Sistema de temas

A seção Configurações → Template reúne as opções de apresentação disponíveis para a loja. Faça a alteração na loja correta e confira o resultado na vitrine antes de compartilhar o endereço com clientes.

Segurança

  • Não compartilhe senha, códigos de autenticação ou sessões do painel com integrações.
  • Mantenha chaves de API e credenciais de gateway no backend ou em um cofre de segredos.
  • Use HTTPS em endpoints externos e limite o acesso às pessoas que administram a loja.
  • Revogue credenciais que não são mais necessárias ou que possam ter sido expostas.
  • Não envie dados pessoais de clientes em logs ou ferramentas de terceiros sem necessidade.
Use ↑ ↓ para navegarEnter para abrir