Gerar o documento
Mostra o modelo com dados de exemplo, preenche com os dados de um pedido real e baixa o resultado pronto para imprimir.
Três formas de ver um modelo preenchido. preview usa dados de exemplo fixos (uma cliente "Maria Silva", pedido VND-2026-00123), útil enquanto você edita. render usa um pedido real, indicado em entity_id. pdf baixa o resultado como um arquivo HTML que abre a janela de impressão do navegador, de onde o usuário salva como PDF.
Pré-visualizar
/api/v1/admin/documents/{id}/previewAdminPré-visualizar com dados de exemplo
Parâmetros de caminho
iduuidobrigatórioId do modelo (UUID).
Exemplo de requisição (preview)
bash
curl "$BASE_URL/api/v1/admin/documents/3204f98e-2c66-42d5-baee-bbc191a1b063/preview" \
-H "Authorization: Bearer $TOKEN"Resposta (preview)
200HTML preenchido
json
{
"html": "<h1>Pedido VND-2026-00123</h1><p>Maria Silva total R$ 182,00</p>"
}Campos da resposta
htmlstringO HTML do modelo com os marcadores trocados pelos dados de exemplo.
Erros (preview)
| Status | Quando | Corpo |
|---|---|---|
| 401 | Sem token, token inválido ou expirado. | {"error":"missing authorization header"} |
| 404 | O modelo não existe. | {"error":"document not found"} |
| 500 | Falha inesperada no servidor. | {"error":"failed to ..."} |
Gerar de um pedido
/api/v1/admin/documents/{id}/renderAdminGerar o documento de um pedido
Parâmetros de caminho
iduuidobrigatórioId do modelo (UUID).
Parâmetros de consulta
entity_iduuidobrigatórioId do pedido (UUID) cujos dados preencherão o modelo.
Exemplo de requisição (render)
bash
curl -X POST "$BASE_URL/api/v1/admin/documents/3204f98e-2c66-42d5-baee-bbc191a1b063/render?entity_id=6af86ed3-d949-474d-8e04-513c6e83bfe4" \
-H "Authorization: Bearer $TOKEN"Resposta (render)
200HTML preenchido
json
{
"html": "<h1>Pedido PILOT-20261011-0009</h1><p>Docs Cliente total R$ 52,66</p>"
}Campos da resposta
htmlstringO HTML com os dados do pedido.
Erros (render)
| Status | Quando | Corpo |
|---|---|---|
| 401 | Sem token, token inválido ou expirado. | {"error":"missing authorization header"} |
| 400 | Falta entity_id. | {"error":"entity_id query parameter is required"} |
| 404 | O modelo não existe. | {"error":"document not found"} |
| 500 | O pedido não existe (hoje volta como 500, não 404) ou falha ao preencher. | {"error":"failed to render document","detail":"fetch order data: order not found: ..."} |
Baixar para imprimir
/api/v1/admin/documents/{id}/pdfAdminBaixar o documento pronto para imprimir
Parâmetros de caminho
iduuidobrigatórioId do modelo (UUID).
Parâmetros de consulta
entity_iduuidId do pedido. Sem ele, o arquivo traz os dados de exemplo.
Exemplo de requisição (pdf)
bash
curl "$BASE_URL/api/v1/admin/documents/3204f98e-2c66-42d5-baee-bbc191a1b063/pdf?entity_id=6af86ed3-d949-474d-8e04-513c6e83bfe4" \
-H "Authorization: Bearer $TOKEN"Resposta (pdf)
200Arquivo HTML para impressão
text
<!doctype html>
<html lang="pt-BR"><head><meta charset="utf-8">
<title>Document 3204f98e-...</title>
<script>window.addEventListener('load', function(){ setTimeout(function(){ window.print(); }, 250); });</script>
</head><body><h1>Pedido PILOT-20261011-0009</h1>...</body></html>Campos da resposta
(corpo)text/htmlUm documento HTML completo, com estilo de impressão e um script que abre a janela de impressão ao carregar. Cabeçalhos:
Content-Type: text/html; charset=utf-8 e Content-Disposition: attachment; filename="document-{id}[-{entity_id}].html".Erros (pdf)
| Status | Quando | Corpo |
|---|---|---|
| 401 | Sem token, token inválido ou expirado. | {"error":"missing authorization header"} |
| 500 | Modelo ou pedido inexistente, ou falha ao preencher. Aqui um modelo inexistente também volta 500. | {"error":"failed to render document","detail":"document not found"} |