Skip to content

Atualização de Pré-renderização

POST /pre-render/refresh

Força a atualização do conteúdo HTML pré-renderizado de uma página.

Descrição

O endpoint de atualização de pré-renderização permite que administradores solicitem a re-renderização imediata do conteúdo HTML de uma URI específica.

Este processo é executado sob demanda e de forma síncrona, ignorando a fila padrão de processamento do sistema de renderização.

É fundamental que o template solicitado esteja corretamente vinculado ao canal de venda informado e que a funcionalidade de pré-renderização esteja habilitada nas configurações do template.

Caso contrário, o processo retornará um erro de permissão ou de recurso não encontrado.

Este recurso é ideal para cenários onde alterações críticas de conteúdo ou SEO precisam ser refletidas instantaneamente para robôs de busca e serviços de compartilhamento social.

O uso deste endpoint requer autenticação de usuário através do middleware UserAuth.

Parâmetros

Headers Obrigatórios

HeaderValorDescrição
Content-Typeapplication/jsonTipo de conteúdo
AuthorizationBearer {userToken}Token de autenticação do usuário

Parâmetros do Corpo

ParâmetroTipoObrigatórioDescrição
templateIdintegerSimID único do template que será utilizado para a renderização.
salesChannelIdintegerSimID do canal de venda ao qual a URI e o template pertencem.
uristringSimO caminho relativo (URI) da página que deve ser re-renderizada (ex: /produto-exemplo).

Exemplo de Requisição

1curl --request POST \
2 --url https://sua-loja-uappi.com.br/api/v3/api/v3/pre-render/refresh \
3 --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4 --header "Content-Type: application/json" \
5 --data '{
6 "templateId": 1,
7 "salesChannelId": 1,
8 "uri": "/produto-exemplo-123"
9 }'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2 "body": "<html>...<body>Conteúdo Renderizado</body></html>",
3 "error": null
4}

⚠️ Possíveis erros:

Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.

Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.

Código InternoCódigo HttpDescrição
UAPPI_RENDER_TEMPLATE_SALES_CHANNEL_LINK_NOT_FOUND404Template não está vinculado ao canal de vendas e loja especificados.
UAPPI_RENDER_PRE_RENDERIZATION_NOT_ENABLED403A flag de pré-renderização não está habilitada para o canal de venda.
UAPPI_RENDER_THROWABLE_ERROR500Erro interno de renderização.

Uappi é a melhor opção para o crescimento da sua loja!

;