O TucanoDocs oferece uma API poderosa para gerar PDFs a partir de templates previamente criados. Para gerar um documento, basta fazer uma requisição POST
para a rota de API específica do template e incluir o token de autenticação e os dados necessários para o preenchimento do documento. Vamos detalhar o processo abaixo.
A rota para gerar o PDF é baseada no ID do template que você criou anteriormente. A estrutura da rota é a seguinte:
1POST https://docs.tucano.app/api/<template_id>
Substitua <template_id>
pelo ID do template que você deseja usar para gerar o documento. Esse ID é único para cada template e pode ser encontrado no painel de gerenciamento de templates.
Para garantir a segurança das requisições, é necessário incluir o token de autenticação único na requisição. O token deve ser passado nos headers da requisição da seguinte maneira:
1--header "Content-Type: application/json" \2--header 'X-API-KEY: t_docs_7832MjA6MTE6UjlkM3h4emxpTExzeFR0aQ='
O cabeçalho X-API-KEY
deve conter o seu token de API exclusivo. Esse token pode ser encontrado nas configurações da sua conta no TucanoDocs. Ele autentica sua requisição e garante que somente você ou quem possuir o token poderá gerar documentos a partir dos seus templates.
O corpo da requisição POST
deve conter os dados necessários para preencher os campos variáveis do template. O conteúdo deve estar no formato JSON. A estrutura básica de envio de dados é a seguinte:
1--data '{2 "nome": "João Silva",3 "endereco": "Rua das Flores, 123",4 "cidade": "São Paulo",5 "font": {6 "family": "'Courier Prime', monospace;",7 "url": "https://fonts.googleapis.com/css2?family=Courier+Prime:ital,wght@0,400;0,700;1,400;1,700&family=Roboto+Mono:ital,wght@0,100..700;1,100..700&display=swap"8 }9}'
Neste exemplo, os dados do PDF incluem informações como nome
, endereco
, e cidade
, que serão usados para preencher os campos variáveis no template. Além disso, você pode customizar a fonte do PDF incluindo o campo font
com a propriedade family
para definir a família de fontes e url
para fornecer a URL da fonte hospedada externamente, como no Google Fonts.
Ao fazer a requisição corretamente, a API retornará um arquivo PDF gerado com os dados fornecidos. O status da requisição pode ser verificado pelos códigos HTTP, como 200 OK
para uma geração bem-sucedida ou outros códigos em caso de erros.
Aqui está um exemplo completo de como seria a requisição POST
para a geração de um PDF no TucanoDocs:
1curl -X POST https://docs.tucano.app/api/<template_id> \2--header "Content-Type: application/json" \3--header 'X-API-KEY: t_docs_7832MjA6MTE6UjlkM3h4emxpTExzeFR0aQ=' \4--data '{5 "nome": "João Silva",6 "endereco": "Rua das Flores, 123",7 "cidade": "São Paulo",8 "font": {9 "family": "'Courier Prime', monospace;",10 "url": "https://fonts.googleapis.com/css2?family=Courier+Prime:ital,wght@0,400;0,700;1,400;1,700&family=Roboto+Mono:ital,wght@0,100..700;1,100..700&display=swap"11 }12}'
Esse comando curl
faz a requisição para a rota de geração de PDF, passando o token de autenticação nos headers e os dados no corpo da requisição.
A geração de PDFs no TucanoDocs é rápida, segura e altamente customizável. Utilizando o template certo, o token de autenticação e os dados corretos, você pode gerar documentos dinâmicos com facilidade e precisão. Explore a API e aproveite todas as funcionalidades para integrar a geração de PDFs nos seus sistemas e fluxos de trabalho.