Gerar documentos

Aqui estão reunidas informações técnicas sobre o consumo da API disponível para criação de documentos.

Para obter informações sobre como configurar integrações e templates consulte O que é a geração automática de documentos, Como configurar um template e Como configurar uma integração para gerar documentos.

Como gerar documentos no Zeev utilizando API?

Para gerar documentos utilizando API siga os passos abaixo:

1. Obtenha o InstanceId: Obtenha o código identificador da instância de solicitação. Para uma execução manual ou externa é possível encontra-lo na página Monitorar > Solicitações, ou através de consultas de API como explicado em Listar todas as solicitações do sistema. Se o endpoint for utilizado dentro de uma integração do Zeev, considere usar {Instance.Id} conforme explicado em Tokens de instâncias de solicitações;

2. Obtenha o xmlProcess: É um texto estruturado contendo as informações dos campos que vão preencher o template. Se utilizado a partir de uma Integração do Zeev, considere utilizar {Instance.Xml} para enviar os dados do formulário de uma instancia durante a execução. Tamém é possível utilizar o padrão especificado em Exemplo de XML de processo

3. Obtenha o templatePath: Informe aqui o caminho relativo do template criado. Veja com obter emComo configurar um template;

4. Defina o generatedFilename: Defina o nome do arquivo gerado;

5. Defina o tipo de documento gerado: Utilize 0 para que o resultado do arquivo gerado seja um PDF ou 1 para que seja um DOCX;

6. Envie a requisição: Com todos os dados elabore o corpo da requisição e envie a requisição para Gerar documentos

Exemplo de XML de processo

<workflow><execute><form><formField name=\"campoA\" order=\"1\" codFieldGroup=\"\" fieldGroupName=\"\">Valor do Campo A</formField></form></execute></workflow>

Exemplo simples do corpo de requisição para gerar arquivo

{
  "instanceId": 1251,
  "xmlProcess": "<workflow><execute><form><formField name=\"nomePessoal\" order=\"1\" codFieldGroup=\"\" fieldGroupName=\"\">Lucas da Silva</formField></form></execute></workflow>",
  "templatePath": "/attachments/template/example.docx",
  "generatedFilename": "CreateFile Example",
  "outputFileFormat": 0
}

Exemplo de requisição utilizando tokens de variável do Zeev

{
  "instanceId": {Instance.Id},
  "xmlProcess": "{Instance.Xml}", // {Instance.Xml} mantém o comportamento atual (sem preservação de \n)
  "xmlProcess": "{Instance.Xml.KeepLineBreaks}", //{Instance.Xml.KeepLineBreaks} gera quebra de linhas a partir do enter inserido.
  "templatePath": "/attachments/template/example.docx",
  "generatedFilename": "CreateFile Example",
  "outputFileFormat": 0
}

Observar a diferença de uso de {Instance.Xml} e {Instance.Xml.KeepLineBreaks}.

O token chamado KeepLineBreaks é responsável por fazer a quebra de linha durante a geração de um arquivo a partir do "Enter". Anteriormente, as quebras de linha durante geração de documento eram realizadas com o \n.

Gerar um documento PDF ou DOCX populando-o com informações e variáveis da instância da solicitação (Auth)

post

Autorizações

AuthorizationstringObrigatório

Utilize um token válido de usuário para realizar a requisição

Corpo

instanceIdinteger · int32 · mín: 1 · máx: 2147483647Obrigatório

Identificador da instância

xmlProcessstringOpcional

Xml de valores do formulário

templatePathstringObrigatório

Endereço absoluto/relativo do arquivo de template docx

htmlTemplateUidstringOpcional

UID do arquivo de template html

generatedFilenamestringObrigatório

Nome do arquivo a ser gerado, sem extensão

outputFileFormatinteger · enum · máx: 1Opcional

Formato do arquivo de saída (Pdf/Docx)

Valores possíveis:

showInfoAboutDocumentbooleanOpcional

Mostrar informações básicas sobre o documento

shouldSignbooleanOpcional

Assinar o documento digitalmente

shouldTrackQrcodebooleanOpcional

Incluir QRCODE e dados para consulta de autenticidade

shouldWatermarkbooleanOpcional

Incluir marca d'água no documento

Respostas

200

Sucesso

resultstringOpcional

Path do arquivo gerado

400

Solicitação ou dados da solicitação são inválidas

401

Pessoa não autorizada

403

Pessoa não tem permissão de executar essa operação

404

O registro não foi encontrado

429

Muitas requisições em um determinado período de tempo

500

Ocorreu algum erro interno no servidor

post/api/2/files/createfile

POST /api/2/files/createfile HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 431

{
  "instanceId": 1251,
  "xmlProcess": "<workflow><execute><form><formField name=\"nomePessoal\" order=\"1\" codFieldGroup=\"\" fieldGroupName=\"\">Lucas da Silva</formField></form></execute></workflow>",
  "templatePath": "/attachments/template/example.docx",
  "htmlTemplateUid": "",
  "generatedFilename": "CreateFile Example",
  "outputFileFormat": 0,
  "showInfoAboutDocument": false,
  "shouldSign": false,
  "shouldTrackQrcode": false,
  "shouldWatermark": false
}

{
  "result": "text"
}

Exemplo de requisição para criação de documentos

Node.js

const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Accept", "application/json");
myHeaders.append("Authorization", "Bearer TOKEN_DO_USUARIO");

const raw = JSON.stringify({
  "instanceId": 1251,
  "xmlProcess": "<workflow><execute><form><formField name=\"nomePessoal\" order=\"1\" codFieldGroup=\"\" fieldGroupName=\"\">Lucas da Silva</formField></form></execute></workflow>",
  "templatePath": "/attachments/template/example.docx",
  "generatedFilename": "CreateFile Example",
  "outputFileFormat": 0
});

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw
};

try {
  const response = await fetch("https://seu_endereco.do.zeev/api/2/files/createfile", requestOptions);
  const result = await response.text();
  console.log(result)
} catch (error) {
  console.error(error);
};

---

Links relacionados:

• O que é preciso para fazer integrações do Zeev para outros sistemas?

• Como autenticar nas APIs do Zeev

• Como controlar o volume máximo de requisições à APIs

• Como acessar o Swagger / OpenAPI

• O que é a geração automática de documentos

• Como configurar uma integração para gerar documentos

• Como configurar um template