Pular para o conteúdo

Endpoints

Todos os endpoints recebem Authorization: Bearer <chave> e, onde há corpo, JSON, salvo indicação em contrário. A descrição legível por máquina é o documento OpenAPI servido em /openapi.json no host da API.

Método e caminho Para quê
POST /v1/render Gera um PDF, ou um link para ele. Custa um crédito. Detalhes.
POST /v1/validate Confere um documento sem gerá-lo para você. Grátis. Detalhes.
GET /v1/files/{id}?exp=…&sig=… Abre um PDF a partir de um link assinado. Não precisa de chave.
Método e caminho Para quê
GET /v1/templates Lista os seus templates.
POST /v1/templates Cria um template. O código precisa compilar.
GET /v1/templates/{id} Lê um template.
PATCH /v1/templates/{id} Altera campos de um template. Só os campos enviados mudam.
DELETE /v1/templates/{id} Apaga um template.
Método e caminho Para quê
POST /v1/assets?name=… Envia um PNG ou JPEG. O corpo é a imagem pura. Detalhes.
GET /v1/assets Lista as suas imagens.
DELETE /v1/assets/{id} Apaga uma imagem.
Método e caminho Para quê
GET /v1/me Seu plano, seus créditos e o fim do período atual.

As chaves de API são criadas e revogadas no portal, não pela API, para que uma chave vazada não possa criar outras.