Async e webhooks

Para PDFs grandes, capturas de página inteira ou alto volume, renderize assincronamente: enfileire o trabalho, obtenha um id imediatamente, depois faça polling ou receba um webhook assinado.

# Enfileire

Adicione async: true (ou uma webhookUrl, ou um notifyEmail) a qualquer solicitação de render ou screenshot. Forneça webhookUrl para um callback assinado, notifyEmail para receber um email quando o trabalho terminar, ou nenhum dos dois e apenas faça polling:

bash

curl https://api.mostlyrender.com/v1/renders \
  -H "Authorization: Bearer mr_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "template": "tpl_abc",
    "output": "pdf",
    "async": true,
    "webhookUrl": "https://your.app/hooks/mostlyrender"
  }'

json

{ "id": "job_xyz789", "status": "queued" }

A resposta é 202 Accepted com um id de trabalho.

# Faça polling

bash

curl https://api.mostlyrender.com/v1/renders/job_xyz789 \
  -H "Authorization: Bearer mr_live_…"

json

{
  "id": "job_xyz789",
  "status": "done",
  "kind": "render",
  "result": { "id": "rnd_abc", "url": "https://img.mostlyrender.com/…/rnd_abc.pdf", "output": "pdf" },
  "error": null
}

status segue queued → processing → done (ou error). Quando done, result contém o render { id, url, output }.

python

job = mr.render_async("tpl_abc", output="pdf", webhook_url="https://your.app/hooks/mostlyrender")
final = mr.wait_for_render(job["id"])
print(final["result"]["url"])

# Webhooks

Se você passar uma webhookUrl, MostlyRender POSTa o resultado do trabalho lá quando terminar:

json

{
  "id": "job_xyz789",
  "status": "done",
  "result": { "id": "rnd_abc", "url": "https://img.mostlyrender.com/…/rnd_abc.pdf", "output": "pdf" }
}

# Verifique a assinatura

Cada webhook carrega uma assinatura HMAC-SHA256 do corpo bruto no cabeçalho x-mostlyrender-signature, prefixado com sha256=. Recalcule-o com seu segredo de assinatura e compare em tempo constante:

import crypto from 'node:crypto';

function verify(rawBody, header, secret) {
  const expected = 'sha256=' + crypto.createHmac('sha256', secret).update(rawBody).digest('hex');
  return crypto.timingSafeEqual(Buffer.from(header), Buffer.from(expected));
}

Responda com qualquer 2xx para confirmar. A entrega é repetida algumas vezes em caso de falha; os destinos de webhook são protegidos contra SSRF assim como as URLs de screenshot.