TemplioniX (versão prévia)

TemplioniX é uma API de geração de documentos para criar arquivos DOCX e PDF de modelos de Word reutilizáveis. Use esse conector para extrair metadados de modelo, gerar um único documento, executar a geração de documentos em massa, verificar o status do trabalho em massa, baixar os resultados gerados e exibir informações de assinatura ou uso.

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

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

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

Service	Class	Regions
Copilot Studio	Premium	Todas as regiões Power Automate exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos	Standard	Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Azure Governamental regiões - Azure regiões da China - Departamento de Defesa dos EUA (DoD)
Power Apps	Premium	Todas as regiões Power Apps exceto as seguintes: – Governo dos EUA (GCC) – 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 (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

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

Metadados do conector
Publicador	TemplioniX
Website	https://templionix.com
Política de privacidade	https://templionix.com/privacy-policy
Termos de uso	https://templionix.com/terms-of-use
Categories	Produtividade; Conteúdo e arquivos
IconBrandColor	#333A41

Conector TemplioniX

Visão geral

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

Esse conector permite que os usuários conectem fluxos de trabalho Microsoft Power Automate, Power Apps, Aplicativos Lógicos do Azure e Copilot Studio à API TemplioniX. Os usuários podem extrair metadados de modelo, gerar cargas JSON inseridas, gerar documentos, executar trabalhos de geração de documentos em massa, verificar o status do trabalho, baixar os resultados gerados e recuperar modelos disponíveis.

Publicador

TemplioniX

Produtos de Microsoft pretendidos

Microsoft Power Automate (automatização de processos)

O conector é implementado como um conector personalizado Microsoft Power Platform e pode ser utilizável em outras experiências de conector Microsoft em que há suporte para conectores certificados.

Autenticação

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

Os usuários devem ter uma conta TemplioniX ativa e uma chave de API válida para usar esse conector.

Principais recursos

Obter modelos

Recupera uma lista paginada de modelos de documento disponíveis do TemplioniX. Essa 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 de documentos em massa.

Extrair campos de modelo e espaços reservados

Extrai metadados de um modelo selecionado, incluindo campos de modelo e espaços reservados. Isso ajuda os usuários a entender quais dados são esperados pelo modelo.

Gerar um conteúdo JSON inicial para um modelo

Gera um exemplo de conteúdo JSON com base no modelo selecionado. Os usuários podem usar esse conteúdo como ponto de partida para mapear dados de outros sistemas em uma solicitação de geração de documento.

Gerar um documento

Gera um documento DOCX ou PDF de um modelo selecionado e dados JSON de entrada.

Gerar documentos em massa

Inicia um trabalho de geração de documentos em massa usando um modelo selecionado e vários registros de entrada. Os links de download zip em massa gerados são válidos por 24 horas.

Obter o status do trabalho de geração em massa

Recupera as informações de status e de resultado de um trabalho específico de geração de documentos em massa.

Obter trabalhos de geração em massa por modelo

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

Cenários comuns de uso

Gere contratos, faturas, propostas, relatórios, cartas e outros documentos comerciais a partir de dados estruturados.
Automatize a criação de documentos com base em CRM, ERP, formulários, Excel, SharePoint, Dataverse, SQL ou sistemas baseados em API.
Crie documentos individuais sob demanda a partir de um fluxo de trabalho.
Gere vários documentos em massa e recupere o resultado zip gerado.
Use metadados de modelo extraídos para entender quais campos são necessários para a geração de documentos.

Fluxo de trabalho de exemplo

Dispare um fluxo manualmente ou de um evento de negócios.
Use a operação Obter modelos para selecionar um modelo.
Use a operação de carga Gerar um JSON inicial para entender a estrutura de dados esperada.
Mapeie os dados do sistema de origem para a estrutura JSON gerada.
Use a operação Gerar um documento para criar um arquivo DOCX ou PDF.
Salve o arquivo gerado em OneDrive, SharePoint, Dataverse, email ou outro destino.

Support

Para obter informações do produto, documentação e suporte, visite:

Site: https://templionix.com
Documentação: https://docs.templionix.com
Suporte: https://templionix.com/contact
Política de privacidade: https://templionix.com/privacy-policy
Termos de uso: https://templionix.com/terms-of-use

Notas para revisão de certificação

Esse pacote contém a solução de conector TemplioniX e uma solução de fluxo de exemplo que demonstra as operações do conector. O conector se comunica com a API TemplioniX de produção e usa a autenticação de chave de API por meio do x-functions-key cabeçalho.

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:


Default	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.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome	Tipo	Description	Obrigatório
Chave de API TemplioniX	secureString	A Chave de API TemplioniX para esta api	True

Limitações

Nome	Chamadas	Período de renovação
Chamadas à API por conexão	100	60 segundos

Ações

Extrair campos de modelo e espaços reservados	Lê o modelo selecionado e retorna os controles de conteúdo descobertos no documento, incluindo o título, a marca, o tipo e os valores predefinidos quando disponíveis.
Gerar um conteúdo JSON inicial para um modelo	Cria uma estrutura JSON de exemplo que corresponde aos espaços reservados descobertos no modelo selecionado para que ele possa ser reutilizado como entrada para a geração de documentos
Gerar um documento com base em dados de modelo	Mescla o conteúdo JSON fornecido com o modelo selecionado e retorna o documento gerado. Usar `.docx` para saída de Word ou `.pdf` para saída de PDF
Iniciar a geração de documentos em massa	Inicie o trabalho em massa para gerar documentos de um modelo compartilhado, crie um ZIP com uma URL SAS de leitura e acompanhe o progresso. Retorna a ID do trabalho imediatamente. A URL de download zip retornada está disponível após a conclusão do trabalho e é válida por 24 horas a partir do tempo de geração.
Listar modelos disponíveis	Retorna uma lista paginada de modelos que podem ser usados com extração de metadados, geração de modelo e pontos de extremidade de geração de documentos
Listar trabalhos de geração em massa para um modelo	Retorna todos os trabalhos para a partição de geração em massa em que TemplateId corresponde; mesma forma de carga que o status de trabalho único, classificado pela hora de início decrescente
Obter o status do trabalho de geração em massa	Carrega o status do trabalho por ID: status, horários de início/término, URL DE SAS ZIP quando concluída, erro de orquestração quando falha e falhas de geração por item analisadas.

Extrair campos de modelo e espaços reservados

ID da operação:: GenerateTemplateMetadata

Lê o modelo selecionado e retorna os controles de conteúdo descobertos no documento, incluindo o título, a marca, o tipo e os valores predefinidos quando disponíveis.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Identificador de modelo	templateId	True	uuid	Identificador de modelo exclusivo retornado pelo catálogo de modelos

Retornos

response: array of contentControlInfoDto

Gerar um conteúdo JSON inicial para um modelo

ID da operação:: GenerateModel

Cria uma estrutura JSON de exemplo que corresponde aos espaços reservados descobertos no modelo selecionado para que ele possa ser reutilizado como entrada para a geração de documentos

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Identificador de modelo	templateId	True	uuid	Identificador de modelo exclusivo retornado pelo catálogo de modelos

Retornos

response: object

Gerar um documento com base em dados de modelo

ID da operação:: GenerateDocument

Mescla o conteúdo JSON fornecido com o modelo selecionado e retorna o documento gerado. Usar .docx para saída de Word ou .pdf para saída de PDF

Parâmetros

Nome	Chave	Tipo	Description
Modelo	templateId	uuid	Identificador de modelo exclusivo
dados	data	object	Objeto JSON que contém valores para espaços reservados de modelo.
Nome do documento	documentName	string	Nome do documento gerado sem extensão, a menos que sua API aceite uma extensão
Format	format	string	Formato de saída. Use .docx para documentos Word ou .pdf para documentos PDF.

Retornos

response: file

Iniciar a geração de documentos em massa

ID da operação:: GenerateDocumentsBulk

Inicie o trabalho em massa para gerar documentos de um modelo compartilhado, crie um ZIP com uma URL SAS de leitura e acompanhe o progresso. Retorna a ID do trabalho imediatamente. A URL de download zip retornada está disponível após a conclusão do trabalho e é válida por 24 horas a partir do tempo de geração.

Parâmetros

Nome	Chave	Tipo	Description
Modelo	templateId	uuid	Identificador de modelo exclusivo
Format	format	string	Formato de saída. Usar .docx para documentos Word ou .pdf para documentos PDF
Nome do arquivo	fileName	string	Nome do arquivo gerado ou solicitado
items	items	object

Retornos

Resposta retornada quando um trabalho de geração de documentos em massa foi aceito para processamento.

Corpo: bulkGenerationAcceptedDto

Listar modelos disponíveis

ID da operação:: GetTemplates

Retorna uma lista paginada de modelos que podem ser usados com extração de metadados, geração de modelo e pontos de extremidade de geração de documentos

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Número da página	pageNumber	True	integer	Índice de página baseado em 1 a ser retornado
Tamanho da página	pageSize	True	integer	Número máximo de modelos a serem retornados em uma única resposta

Retornos

Resposta paginada baseada em deslocamento que contém registros de modelo.

Corpo: pagedResponseOffsetDto_templateInfoDto

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

ID da operação:: GetBulkGenerationJobsByTemplateId

Retorna todos os trabalhos para a partição de geração em massa em que TemplateId corresponde; mesma forma de carga que o status de trabalho único, classificado pela hora de início decrescente

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Identificador de modelo	templateId	True	uuid	Somente os trabalhos iniciados com essa ID de modelo são retornados

Retornos

response: array of bulkGenerationJobStatusDto

Obter o status do trabalho de geração em massa

ID da operação:: GetBulkGenerationJobStatus

Carrega o status do trabalho por ID: status, horários de início/término, URL DE SAS ZIP quando concluída, erro de orquestração quando falha e falhas de geração por item analisadas.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Identificador de trabalho em massa	jobId	True	string	ID do trabalho retornada na resposta generateDocumentsBulk 202 (`jobId`)

Retornos

Detalhes de status e resultado de um trabalho de geração de documentos em massa.

Corpo: bulkGenerationJobStatusDto

Definições

bulkGenerationAcceptedDto

Resposta retornada quando um trabalho de geração de documentos em massa foi aceito para processamento.

Nome	Caminho	Tipo	Description
ID do trabalho	jobId	string	Identificador de trabalho de geração em massa exclusivo.
Iniciado em	startedAt	date-time	Data e hora UTC quando a operação foi iniciada.

bulkGenerationFailureItemDto

Informações sobre um item de documento com falha em um trabalho de geração em massa.

Nome	Caminho	Tipo	Description
Índice Global	globalIndex	string	Índice ou identificador interno do item gerado com falha.
Nome do arquivo	fileName	string	Nome do arquivo gerado ou solicitado.
Erro	error	string	Mensagem de erro para o item com falha.

bulkGenerationJobStatusDto

Detalhes de status e resultado de um trabalho de geração de documentos em massa.

Nome	Caminho	Tipo	Description
ID do trabalho	jobId	string	Identificador de trabalho de geração em massa exclusivo.
ID do Modelo	templateId	uuid	Identificador de modelo exclusivo.
Status	status	string	Status do trabalho atual, por exemplo: Pendente, Em Execução, Concluído, Com Falha ou ParcialmenteCompletado.
Iniciado em	startedAt	date-time	Data e hora UTC quando a operação foi iniciada.
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 arquivo ZIP gerado. Para geração em massa, esse link é válido por 24 horas a partir do tempo de geração.
Mensagem de erro	errorMessage	string	Mensagem de erro no nível do trabalho, se a orquestração falhar.
Regenerações com falha	failedGenerations	array of bulkGenerationFailureItemDto	Coleção de itens com falha dentro de um trabalho de geração em massa.
Contagem de geração com falha	failedGenerationCount	integer	Número de itens com falha dentro de um trabalho de geração em massa.

categoryDto

Informações de categoria de modelo.

Nome	Caminho	Tipo	Description
id	id	uuid	Identificador exclusivo.
name	name	string	Nome de exibição.

contentControlInfoDto

Metadados de um Word controle de conteúdo ou espaço reservado descoberto em um modelo.

Nome	Caminho	Tipo	Description
título	title	string	Título do controle de conteúdo.
marca	tag	string	Marca de controle de conteúdo usada como uma chave de campo JSON.
tipo	type	string	Tipo de controle de conteúdo.

pagedResponseOffsetDto_templateInfoDto

Resposta paginada baseada em deslocamento que contém registros de modelo.

Nome	Caminho	Tipo	Description
dados	data	array of templateInfoDto	Objeto JSON que contém valores para espaços reservados de modelo.
Número da Página	pageNumber	integer	Número da página atual.
Tamanho da Página	pageSize	integer	Número de registros por página.
Total de registros	totalRecords	integer	Número total de registros disponíveis.
Total de Páginas	totalPages	integer	Número total de páginas.

templateInfoDto

Item de catálogo de modelo retornado pelo ponto de extremidade da lista de modelos.

Nome	Caminho	Tipo	Description
ID	id	uuid	Identificador exclusivo.
Nome	name	string	Nome de exibição.
Description	description	string	Descrição legível por humanos.
Data da criação	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 de modelo.

arquivo

Esse é o tipo de dados básico 'file'.

objeto

Esse é o tipo 'object'.