Início rápido

Cinco minutos até seu primeiro documento

Esta página leva você do zero a um PDF no disco. Ela usa o modelo de Fatura presente em todos os espaços de trabalho, sem precisar criar um design primeiro.

1. Sua chave

Crie uma chave em Conta → Chaves de API. O segredo é exibido uma vez; mantenha-o fora do código-fonte. Cada chamada o inclui no cabeçalho X-PDFgine-Key.

# A chave fica no ambiente, não no código
export PDFGINE_KEY="pdfgine_live_..."

# Está funcionando? Esta chamada lista seus modelos
curl https://api.pdfgine.com/api/v1/templates \
  -H "X-PDFgine-Key: $PDFGINE_KEY"

2. Produza um documento

Uma chamada com o código do modelo e seus dados. A resposta é 202 com documentId e uma URL de download.

curl -X POST https://api.pdfgine.com/api/v1/render \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "templateCode": "invoice",
        "format": "pdf",
        "locale": "pt",
        "data": {
          "document": { "title": "Resumo da fatura" },
          "referenceNo": "DOC-2026-0042",
          "issueDate": "2026-09-06",
          "currency": "USD",
          "customer": "Northwind Trading Ltd.",
          "lineItems": [
            { "name": "Diagnóstico de falhas", "quantity": 2, "unitPrice": 850.00 }
          ]
        }
      }'

Ao testar um modelo, envie "purpose": "editor-test": essa saída não consome sua cota e usa o rascunho não publicado.

3. Baixe o documento

A URL de download da resposta é relativa ao endereço da API e é acessada com a mesma chave. Solicite docx em vez de pdf e os mesmos dados serão retornados como arquivo Word.

curl https://api.pdfgine.com/api/v1/documents/doc_a96063f5dcd5400286ce9b3be9b0595b/download/pdf \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -o invoice.pdf

Os primeiros problemas mais comuns

• 402 significa que a cota mensal de páginas acabou; o cabeçalho X-PDFgine-Quota-Remaining avisa antes de você chegar a esse ponto.
• 422 significa que seus dados não atendem ao modelo. O corpo informa todos os campos ausentes em errors, sem precisar adivinhar.
• A renderização responde 202, não 200. Um cliente que trata qualquer código diferente de 200 como falha reportará sucesso como erro.

Próximos passos

Formatos de dados é a página à qual você mais voltará: ela informa exatamente como enviar datas, valores e moedas.