Endereço base
Endereço base
Todos os endpoints ficam sob este prefixo. Em uma instalação local, o endereço padrão é o valor abaixo.
https://api.pdfgine.com/api/v1Paginação nos endpoints de listagem
Cinco endpoints de listagem têm paginação: /history de um modelo, /assets, /marketplace/templates, /templates e /components. Cada um aceita limit (1-200) e before opcionais e continua respondendo com um array simples, sem exigir mudanças dos clientes atuais.
Sem limit, você recebe no máximo 200 linhas e, quando há mais, a resposta inclui um cabeçalho Link com rel="next". Siga esse link em vez de montar a próxima URL: o cursor é um número de versão em history, um ID de recurso em assets e um valor opaco nos demais, e só o cabeçalho sabe qual. Em /marketplace/templates o cursor também inclui os filtros, então deixa de funcionar quando search, category ou locale muda; isso é intencional, pois o mesmo cursor apontaria para outra lista. Os demais endpoints de listagem retornam coleções já limitadas. Uma resposta truncada também inclui X-PDFgine-List-Truncated: true e X-PDFgine-List-Limit; ambos ficam ausentes na última página.
A descrição legível por máquina
Tudo nestas páginas também é publicado como um documento OpenAPI 3.0. Aponte seu gerador de clientes, Postman ou editor para ele e obtenha caminhos, corpos de solicitações e payloads de exemplo sem copiar nada manualmente.
https://api.pdfgine.com/openapi/v1.jsonO documento é gerado pela API em execução, então descreve a versão que você realmente chama, não a versão que alguém lembrou de documentar.