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

Redirecionamentos e slugs

Como a loja redireciona URLs antigas para as novas, evita cadeias e ciclos, e o mapa das rotas de redirecionamento e de slug por idioma.

Quando uma URL muda (um produto é renomeado, a loja migra de plataforma, uma categoria é reorganizada), os links antigos que estão em buscadores, e-mails e favoritos precisam continuar funcionando. Um redirecionamento diz à vitrine: "quem pedir /caminho-antigo vai para /caminho-novo". Esta seção documenta o cadastro desses redirecionamentos, a importação em lote e o ajuste do slug (o trecho legível da URL) por idioma. As rotas de redirecionamento exigem token de administrador e o módulo SEO ativo na loja; a de slug por idioma exige o privilégio manage_categories.

Pontos-chave
  • Um redirecionamento é identificado por UUID, mas o que o torna único é o old_path: criar outro com o mesmo old_path atualiza o existente.
  • status_code é 301 (permanente, o padrão) ou 302 (temporário). Qualquer outro valor vira 301.
  • A plataforma achata cadeias: se /a vai para /b e /b vai para /c, o redirecionamento de /a é gravado já apontando para /c. Ciclos são recusados e cadeias acima de 5 saltos também.
  • Só redirecionamentos ativos (active: true) valem. Cada uso soma em hits.
  • Sem o módulo SEO ativo, as rotas respondem 403 module_disabled.

Como funciona

  1. Cadastre o redirecionamento
    POST /api/v1/admin/seo/redirects com old_path e new_path.
  2. A vitrine aplica
    Ao resolver um caminho, a vitrine procura um redirecionamento ativo para aquele texto exato e responde 301 ou 302 com o destino.
  3. Acompanhe o uso
    Na listagem, hits e last_hit_at mostram se o redirecionamento ainda é usado e podem orientar uma limpeza.

Conceitos-chave

Formato dos caminhos

CampoRegra
old_pathComeça com /. A comparação é exata, texto por texto, incluindo a barra final e maiúsculas.
new_pathComeça com / (caminho da própria loja) ou com http:// ou https:// (outro site). Não pode ser igual a old_path.

Cadeias e ciclos

Ao gravar, a plataforma segue os redirecionamentos ativos a partir do new_path. Se chegar de volta ao old_path, ou repetir um destino, recusa com REDIRECT_LOOP. Se passar de 5 saltos, recusa com REDIRECT_CHAIN_TOO_DEEP. Se terminar em um destino final, grava esse destino. Ao gravar, também reaponta os redirecionamentos que já apontavam para o old_path, para pularem o salto.

Slug por idioma

Em lojas com vários idiomas, cada produto, categoria, página, post de blog e marca pode ter um slug diferente por idioma. A rota de slug por idioma valida o novo texto e guarda o anterior para redirecionar.

Endpoints

MétodoCaminhoPara que serveAuth
GET/api/v1/admin/seo/redirectsListar redirecionamentosadmin
POST/api/v1/admin/seo/redirectsCriar redirecionamentoadmin
GET/api/v1/admin/seo/redirects/{id}Consultar redirecionamentoadmin
PUT/api/v1/admin/seo/redirects/{id}Alterar redirecionamentoadmin
DELETE/api/v1/admin/seo/redirects/{id}Excluir redirecionamentoadmin
POST/api/v1/admin/seo/redirects/bulkImportar ou alterar em loteadmin
PUT/api/v1/admin/seo/localized-slug/{id}Definir slug por idiomaadmin

Erros comuns

  • old_path sem a barra inicial. Retorna 400 old_path must start with /.
  • new_path sem /, http:// ou https://. Retorna 400.
  • Redirecionar um caminho para ele mesmo. Retorna 400 old_path and new_path cannot be identical.
  • Criar um ciclo (/a para /b e /b para /a). Retorna 400 com REDIRECT_LOOP.
  • Achar que o POST falha quando o old_path já existe. Ele atualiza o existente e devolve 201.
  • Esperar 404 ao consultar um id que não é UUID. Retorna 500.
  • Importar CSV grande e ter um erro no meio. A importação em lote é transacional: uma linha inválida cancela o lote inteiro.

Próximos passos

Redirecionamentos
Cadastro individual.
Lote
Importar uma lista inteira de uma vez.
Slug por idioma
URLs diferentes em cada idioma.
Anterior
Itens do menu
Próxima
Redirecionamentos
Nesta página
  • Como funciona
  • Conceitos-chave
  • Formato dos caminhos
  • Cadeias e ciclos
  • Slug por idioma
  • Endpoints
  • Erros comuns
  • Próximos passos