VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Busca

Como a busca da loja é administrada pela API: busca global do painel, estatísticas de busca, motor e reindexação, redirecionamentos por termo, com o mapa das rotas.

"Busca" tem dois lados na Venddor. O lado do cliente é a caixa de busca da vitrine (documentada na seção de busca da vitrine). Esta seção é o lado do administrador: a busca global do painel (a caixa que acha usuário, pedido e produto de uma vez), as estatísticas do que os clientes procuram, o controle do índice que alimenta a busca e os redirecionamentos por termo, que levam quem busca "frete grátis" direto à página certa.

Pontos-chave
  • A busca global (GET /admin/search) não exige privilégio próprio: cada grupo de resultado só vem se o usuário tiver o privilégio daquela área.
  • As estatísticas (/search/analytics/...) e os redirecionamentos exigem manage_settings.
  • Só a busca enviada (Enter) entra nas estatísticas. O autocompletar não é registrado.
  • Os controles do índice dependem do motor de busca que a loja usa (Meilisearch, índice vetorial ou o banco de dados), e três deles exigem o módulo search-management ligado.
  • Um redirecionamento criado sem is_active: true nasce desligado.

Como funciona

Do termo digitado ao resultado

O cliente digita na vitrine, a plataforma normaliza o termo (minúsculas, sem acento, espaços colapsados), consulta o motor de busca e responde com produtos. Se existir um redirecionamento ativo para o termo normalizado, a resposta traz também um redirect_url, e a vitrine leva o cliente para lá. Cada busca enviada é registrada (termo, número de resultados, clique), e uma rotina por hora consolida os números do dia anterior.

Motores de busca

engineQuandoReindexar
meilisearchA loja tem um servidor Meilisearch configurado e acessível.Sim
vectorSem Meilisearch, mas com o índice vetorial de produtos ativo.Sim
databaseNenhum dos dois: a busca consulta direto a tabela de produtos.Não, não há índice para reconstruir

GET /search/meili/status diz qual motor está em uso.

Conceitos-chave

Termo normalizado (term_norm)

Redirecionamentos e estatísticas usam o termo em forma normalizada: minúsculas, sem acentos, espaços repetidos viram um. " Frete Grátis " e "frete gratis" são o mesmo termo.

Taxas são frações

zero_results_pct e ctr vêm como fração de 0 a 1, não percentual: 0.1 é 10%.

Exclusão de redirecionamento

Apagar um redirecionamento é lógico, mas o termo continua ocupado: não é possível criar outro redirecionamento para o mesmo termo depois de apagar o primeiro. Prefira desativar (is_active: false).

Endpoints

MétodoCaminhoPara que serveAuth
GET/api/v1/admin/searchBusca global do paineladmin
GET/api/v1/admin/search/analytics/summaryResumo das buscas da vitrineadmin
GET/api/v1/admin/search/analytics/termsTermos mais buscados ou sem resultadoadmin
GET/api/v1/admin/search/meili/statusEstado do motor de buscaadmin
POST/api/v1/admin/search/meili/ensure-indexCria ou reconfigura o índice do Meilisearchadmin
POST/api/v1/admin/search/meili/reindexReconstrói o índice em segundo planoadmin
POST/api/v1/admin/search/reindexReconstrói o índice de texto completo (síncrono)admin
GET/api/v1/admin/search/redirectsLista os redirecionamentosadmin
POST/api/v1/admin/search/redirectsCria um redirecionamentoadmin
PUT/api/v1/admin/search/redirects/{id}Altera um redirecionamentoadmin
DELETE/api/v1/admin/search/redirects/{id}Apaga um redirecionamentoadmin

Erros comuns

  • Esperar resultados da busca global com uma letra só: com menos de 2 caracteres a resposta é 200 e vazia.
  • Interpretar totals como o total de achados: é a quantidade de itens devolvidos (limitada por limit).
  • Esperar que um grupo de resultado venha quando o usuário não tem o privilégio: o grupo vem vazio, sem erro.
  • Criar um redirecionamento sem is_active e estranhar que não funciona.
  • Tentar recriar um redirecionamento depois de apagado: 409 term already exists.
  • Chamar meili/reindex e esperar que termine na resposta: é 202, o trabalho segue em segundo plano. Já reindex (sem meili) é síncrono.
  • Receber 403 module_disabled nos controles meili/*: o módulo search-management está desligado na loja.

Próximos passos

Busca global
Achar usuários, produtos, pedidos e mais.
Estatísticas
O que os clientes procuram.
Redirecionamentos
Leve um termo a uma página.
Motor e reindexação
Estado e reconstrução do índice.
Anterior
Gerar feed e trocar o token
Próxima
Busca global do painel
Nesta página
  • Como funciona
  • Do termo digitado ao resultado
  • Motores de busca
  • Conceitos-chave
  • Termo normalizado (termnorm)
  • Taxas são frações
  • Exclusão de redirecionamento
  • Endpoints
  • Erros comuns
  • Próximos passos