TemplioniX (Pré-visualização)

O TemplioniX é uma API de geração de documentos para criar ficheiros DOCX e PDF a partir de modelos Word reutilizáveis. Use este conector para extrair metadados modelo, gerar um único documento, gerar documentos em massa, verificar o estado dos trabalhos em massa, descarregar resultados gerados e visualizar informações de subscrição ou utilização.

A autenticação é realizada com uma chave API passada.

Os links de download ZIP gerados em massa são válidos por 24 horas.

Este conector está disponível nos seguintes produtos e regiões:

Serviço	Class	Regions
Estúdio Copiloto	Premium	Todas as regiões Power Automate exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas	Standard	Todas as regiões do Logic Apps , exceto as seguintes: - Regiões Azure Government - Regiões Azure China - Departamento de Defesa dos EUA (DoD)
Power Apps	Premium	Todas as regiões Power Apps exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Power Automate	Premium	Todas as regiões Power Automate exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

Contact
Nome	Suporte TemplioniX
URL	https://templionix.com
Email	support@templionix.com

Metadados do conector
Editora	TemplioniX
Sítio Web	https://templionix.com
Política de privacidade	https://templionix.com/privacy-policy
Termos de utilização	https://templionix.com/terms-of-use
Categorias	Produtividade; Conteúdo e Ficheiros
IconBrandColor	#333A41

Conector TemplioniX

Descrição geral

O TemplioniX é um serviço de geração de documentos que ajuda a criar ficheiros DOCX e PDF a partir de modelos reutilizáveis de Microsoft Word e dados JSON estruturados.

Este conector permite aos utilizadores ligar fluxos de trabalho Microsoft Power Automate, Power Apps, Azure Logic Apps e Copilot Studio à API TemplioniX. Os utilizadores podem extrair metadados de modelos, gerar cargas úteis JSON iniciais, gerar documentos, executar trabalhos de geração em massa de documentos, verificar o estado do trabalho, descarregar resultados gerados e recuperar modelos disponíveis.

Editora

TemplioniX

Produtos pretendidos para a Microsoft

Microsoft Power Automate

O conector é implementado como um conector personalizado da Microsoft Power Platform e pode ser utilizado noutras experiências com conectores Microsoft onde são suportados conectores certificados.

Authentication

O conector usa autenticação de chave de API. A chave API é passada no cabeçalho do x-functions-key pedido.

Os utilizadores devem ter uma conta TemplioniX ativa e uma chave API válida para usar este conector.

Principais capacidades

Obter modelos

Recupera uma lista paginada de modelos de documentos disponíveis no TemplioniX. Esta operação pode ser usada para selecionar um modelo antes de gerar metadados, um modelo inicial, um único documento ou um trabalho de geração em massa de documentos.

Extrair campos de modelo e marcadores de posição

Extrai metadados de um modelo selecionado, incluindo campos e marcadores de posição. Isto ajuda os utilizadores a perceber quais os dados esperados pelo modelo.

Gerar um payload JSON inicial para um modelo

Gera um exemplo de carga útil JSON com base no modelo selecionado. Os utilizadores podem usar esta carga útil como ponto de partida para mapear dados de outros sistemas num pedido de geração de documentos.

Gerar um documento

Gera um documento DOCX ou PDF a partir de um template selecionado e insere dados JSON.

Gerar documentos em massa

Inicia um trabalho de geração de documentos em massa usando um modelo selecionado e múltiplos registos de entrada. Os links de download ZIP gerados em massa são válidos por 24 horas.

Obtenha o estatuto de emprego de geração em massa

Recupera a informação de estado e resultado para um trabalho específico de geração em massa de documentos.

Obtenha empregos de geração em massa por modelo

Recupera trabalhos de geração em massa associados a um modelo selecionado.

Cenários de uso comum

Gerar contratos, faturas, propostas, relatórios, cartas e outros documentos empresariais a partir de dados estruturados.
Automatizar a criação de documentos a partir de CRM, ERP, formulários, Excel, SharePoint, Dataverse, SQL ou sistemas baseados em API.
Crie documentos únicos a pedido através de um fluxo de trabalho.
Gerar vários documentos em massa e recuperar o resultado ZIP gerado.
Utilize metadados de modelos extraídos para perceber quais os campos necessários para a geração de documentos.

Exemplo de fluxo de trabalho

Acione um fluxo manualmente ou a partir de um evento empresarial.
Usa a operação Obter templates para selecionar um template.
Use a operação Generar uma carga útil JSON inicial para compreender a estrutura de dados esperada.
Mapear os dados do sistema de origem para a estrutura JSON gerada.
Use a operação Gerar um documento para criar um ficheiro DOCX ou PDF.
Guarde o ficheiro gerado no OneDrive, SharePoint, Dataverse, email ou outro destino.

Support

Para informações sobre produtos, documentação e suporte, visite:

Sítio Internet: https://templionix.com
Documentação: https://docs.templionix.com
Apoio: https://templionix.com/contact
Política de privacidade: https://templionix.com/privacy-policy
Termos de utilização: https://templionix.com/terms-of-use

Notas para revisão de certificação

Este pacote contém a solução do conector TemplioniX e uma solução de fluxo de amostras que demonstra as operações do conector. O conector comunica com a API TemplioniX de produção e utiliza autenticação por chave API através do x-functions-key cabeçalho.

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:


Predefinição	Parâmetros para criar conexão.	Todas as regiões	Não compartilhável

Padrão

Aplicável: Todas as regiões

Parâmetros para criar conexão.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome	Tipo	Descrição	Obrigatório
Chave Api TemplioniX	securestring	A Chave API TemplioniX para esta API	True

Limites de Limitação

Name	Chamadas	Período de Renovação
Chamadas de API por conexão	100	60 segundos

Ações

Extrair campos de modelo e marcadores de posição	Lê o modelo selecionado e devolve os controlos de conteúdo descobertos no documento, incluindo o seu título, etiqueta, tipo e valores pré-definidos quando disponíveis.
Gerar um documento a partir dos dados do modelo	Funde a carga útil JSON fornecida com o modelo selecionado e devolve o documento gerado. Utilização `.docx` para saída Word ou `.pdf` para saída PDF
Gerar um payload JSON inicial para um modelo	Constrói uma estrutura JSON de exemplo que corresponde aos marcadores de posição descobertos no modelo selecionado para que possa ser reutilizada como entrada para geração de documentos
Iniciar geração em massa de documentos	Inicia um trabalho em massa para gerar documentos a partir de um template partilhado, constrói um código postal com uma URL SAS de leitura e acompanha o progresso. Devolve imediatamente o ID do trabalho. O URL de download ZIP devolvido está disponível após a conclusão do trabalho e é válido durante 24 horas a partir da geração.
Lista de modelos disponíveis	Devolve uma lista paginada de modelos que podem ser usados na extração de metadados, geração de modelos e terminais de geração de documentos
Liste trabalhos de geração em massa para um modelo	Devolve todos os trabalhos da partição de geração em massa onde o TemplateId coincide; Mesma forma da carga útil do estado de um único trabalho, ordenado pela hora de início descendente
Obtenha o estatuto de emprego de geração em massa	Carrega o estado do trabalho por id: estado, horas de início/fim, ZIP SAS URL quando concluído, erro de orquestração quando falhado, e falhas de geração por item analisadas.

Extrair campos de modelo e marcadores de posição

ID da Operação:: GenerateTemplateMetadata

Lê o modelo selecionado e devolve os controlos de conteúdo descobertos no documento, incluindo o seu título, etiqueta, tipo e valores pré-definidos quando disponíveis.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Identificador do modelo	templateId	True	uuid	Identificador único do modelo devolvido pelo catálogo de modelos

Devoluções

response: array of contentControlInfoDto

Gerar um documento a partir dos dados do modelo

ID da Operação:: GenerateDocument

Funde a carga útil JSON fornecida com o modelo selecionado e devolve o documento gerado. Utilização .docx para saída Word ou .pdf para saída PDF

Parâmetros

Name	Chave	Tipo	Descrição
Template	templateId	uuid	Identificador único de modelo
dados	data	object	Objeto JSON contendo valores para marcadores de template (marcadores de posição).
Nome do documento	documentName	string	Nome do documento gerado sem extensão, a menos que a sua API aceite uma extensão
Format	format	string	Formato de saída. Use .docx para documentos Word ou .pdf para documentos PDF.

Devoluções

response: file

Gerar um payload JSON inicial para um modelo

ID da Operação:: GenerateModel

Constrói uma estrutura JSON de exemplo que corresponde aos marcadores de posição descobertos no modelo selecionado para que possa ser reutilizada como entrada para geração de documentos

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Identificador do modelo	templateId	True	uuid	Identificador único do modelo devolvido pelo catálogo de modelos

Devoluções

response: object

Iniciar geração em massa de documentos

ID da Operação:: GenerateDocumentsBulk

Inicia um trabalho em massa para gerar documentos a partir de um template partilhado, constrói um código postal com uma URL SAS de leitura e acompanha o progresso. Devolve imediatamente o ID do trabalho. O URL de download ZIP devolvido está disponível após a conclusão do trabalho e é válido durante 24 horas a partir da geração.

Parâmetros

Name	Chave	Tipo	Descrição
Template	templateId	uuid	Identificador único de modelo
Format	format	string	Formato de saída. Use .docx para documentos Word ou .pdf para documentos PDF
Nome do arquivo	fileName	string	Nome de ficheiro gerado ou solicitado
items	items	object

Devoluções

Resposta devolvida quando um trabalho de geração de documentos em massa é aceite para processamento.

Body: bulkGenerationAcceptedDto

Lista de modelos disponíveis

ID da Operação:: GetTemplates

Devolve uma lista paginada de modelos que podem ser usados na extração de metadados, geração de modelos e terminais de geração de documentos

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Número da página	pageNumber	True	integer	Índice de página baseado em 1 Retorno
Tamanho da página	pageSize	True	integer	Número máximo de templates a devolver numa única resposta

Devoluções

Resposta paginada baseada em deslocamento contendo registos modelo.

Body: pagedResponseOffsetDto_templateInfoDto

Liste trabalhos de geração em massa para um modelo

ID da Operação:: GetBulkGenerationJobsByTemplateId

Devolve todos os trabalhos da partição de geração em massa onde o TemplateId coincide; Mesma forma da carga útil do estado de um único trabalho, ordenado pela hora de início descendente

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Identificador do modelo	templateId	True	uuid	Apenas os trabalhos iniciados com este ID modelo são devolvidos

Devoluções

response: array of bulkGenerationJobStatusDto

Obtenha o estatuto de emprego de geração em massa

ID da Operação:: GetBulkGenerationJobStatus

Carrega o estado do trabalho por id: estado, horas de início/fim, ZIP SAS URL quando concluído, erro de orquestração quando falhado, e falhas de geração por item analisadas.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Identificador de trabalho em massa	jobId	True	string	O ID do trabalho retornou na resposta generateDocumentsBulk 202 (`jobId`)

Devoluções

Estado e detalhes de resultados para um trabalho de geração de documentos em massa.

Body: bulkGenerationJobStatusDto

Definições

BulkGenerationAcceptedDto

Resposta devolvida quando um trabalho de geração de documentos em massa é aceite para processamento.

Name	Caminho	Tipo	Descrição
ID do trabalho	jobId	string	Identificador único de trabalho de geração em massa.
Iniciado em	startedAt	date-time	Data e hora UTC de início da operação.

bulkGenerationFailureItemDto

Informação sobre um item de documento falhado num trabalho de geração em massa.

Name	Caminho	Tipo	Descrição
Índice Global	globalIndex	string	Índice ou identificador interno do item gerado falhado.
Nome do arquivo	fileName	string	Nome de ficheiro gerado ou solicitado.
Erro	error	string	Mensagem de erro para o item falhado.

bulkGeraçãoEmpregoStatusDto

Estado e detalhes de resultados para um trabalho de geração de documentos em massa.

Name	Caminho	Tipo	Descrição
ID do trabalho	jobId	string	Identificador único de trabalho de geração em massa.
ID do modelo	templateId	uuid	Identificador único de modelo.
Situação	status	string	Estado atual do trabalho, por exemplo: Pendente, Em Curso, Concluído, Reprovado ou Parcialmente Concluído.
Iniciado em	startedAt	date-time	Data e hora UTC de início da operação.
Hora de Término	endTime	date-time	Data e hora UTC quando o trabalho terminou.
Zip Url	zipUrl	string	URL de download temporário para o ficheiro ZIP gerado. Para geração em massa, esta ligação é válida durante 24 horas a partir do momento da geração.
Mensagem de erro	errorMessage	string	Mensagem de erro ao nível do trabalho, caso a orquestração tenha falhado.
gerações falhadas	failedGenerations	array of bulkGenerationFailureItemDto	Recolha de itens falhados dentro de um trabalho de geração em massa.
Contagem de Gerações Falhadas	failedGenerationCount	integer	Número de itens falhados dentro de um trabalho de geração em massa.

categoriaDto

Informação sobre a categoria do modelo.

Name	Caminho	Tipo	Descrição
id	id	uuid	Identificador único.
name	name	string	Nome a Apresentar.

contentControlInfoDto

Metadados de um controlo de conteúdo Word ou marcador de posição descobertos num modelo.

Name	Caminho	Tipo	Descrição
título	title	string	Título de controlo de conteúdo.
etiqueta	tag	string	Etiqueta de controlo de conteúdo usada como chave de campo JSON.
tipo	type	string	Tipo de controlo de conteúdo.

pagedResponseOffsetDto_templateInfoDto

Resposta paginada baseada em deslocamento contendo registos modelo.

Name	Caminho	Tipo	Descrição
dados	data	array of templateInfoDto	Objeto JSON contendo valores para marcadores de template (marcadores de posição).
Número da página	pageNumber	integer	Número de página atual.
Tamanho da Página	pageSize	integer	Número de registos por página.
Total de Registos	totalRecords	integer	Número total de registos disponíveis.
Total de Páginas	totalPages	integer	Número total de páginas.

templateInfoDto

Item do catálogo modelo devolvido pelo endpoint da lista de modelos.

Name	Caminho	Tipo	Descrição
ID	id	uuid	Identificador único.
Nome	name	string	Nome a Apresentar.
Descrição	description	string	Descrição legível para humanos.
Criado em	createdOn	date-time	Data e hora UTC em que o modelo foi criado.
Última modificação	lastModified	date-time	Data e hora UTC em que o modelo foi modificado pela última vez.
categorias	categories	array of categoryDto	Categorias modelo.

ficheiro

Este é o tipo de dados básicos 'arquivo'.

objecto

Este é o tipo 'objeto'.