Compartilhar via


APITemplate (Editor Independente)

Com o serviço APITemplate.io, você pode criar documentos e imagens em PDF e gerenciar seus modelos. Gere imagens de mídia social, faixas ou PDFs de modelos reutilizáveis sem codificação!

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

Service Class Regions
Copilot Studio Premium Todas as regiões do 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:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do 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 do 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)
Contato
Nome Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Metadados do conector
Publicador Troy Taylor
Site https://apitemplate.io/
Política de privacidade https://apitemplate.io/privacy-policy/
Categorias Conteúdo e arquivos

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 secureString A chave de API para esta api Verdade

Limitações

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

Ações

Atualizar modelo de PDF

Essa ação atualiza um modelo de PDF.

Criar um PDF

Essa solicitação cria um arquivo PDF com dados JSON e seu modelo. Dá suporte à geração de PDF síncrona e assíncrona.

Criar uma imagem

Essa solicitação cria um arquivo JPEG (juntamente com PNG) de dados JSON e seu modelo.

Excluir um objeto

Exclua um PDF ou uma imagem da CDN e marque a transação como excluída.

Listar modelos

Recupera uma lista dos modelos e suas informações.

Listar objetos gerados

Recupera uma lista de todos os PDFs e imagens gerados.

Mesclar vários PDFs

Essa ação mescla/une vários PDF em um único arquivo PDF.

Obter modelo de PDF

Recupera informações sobre o modelo PDF.

Atualizar modelo de PDF

Essa ação atualiza um modelo de PDF.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Modelo
template_id True string

A ID do modelo pode ser obtida no console Web (Gerenciar Modelos)

Corpo
body string

O corpo HTML

CSS
css string

O css

Retornos

ResponseSuccess
ResponseSuccess

Criar um PDF

Essa solicitação cria um arquivo PDF com dados JSON e seu modelo. Dá suporte à geração de PDF síncrona e assíncrona.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Modelo
template_id True string

A ID do modelo pode ser obtida no console Web (Gerenciar Modelos)

Tipo de Exportação
export_type string

jsonOu file (Padrão). A opção json retorna um objeto JSON e o PDF de saída é armazenado em uma CDN. Use isso com o parâmetro expiration. A opção file retorna dados binários do PDF gerado (seguro e completamente privado) e o cabeçalho HTTP de resposta Content-Disposition é definido como anexo.

Vencimento
expiration integer

Expiração do PDF gerado em minutos(padrão para 0, armazenar permanentemente). Use 0 para armazenar permanentemente na CDN. Ou use o intervalo entre 1 minutos e 10080 minutos (7 dias) para especificar a expiração do PDF gerado

HTML de saída
output_html string

0Ou 1 (Padrão).. Para habilitar a saída do conteúdo html, defina o valor 1 e ele retornará na resposta JSON como html_url campo (como uma URL)

Formato de saída
output_format string

( pdfPadrão) ou html.. Ele está gerando PDF por padrão. No entanto, você pode especificar output_format=html para gerar apenas HTML(ele retornará na resposta JSON como download_url campo como uma URL).

Nome do Arquivo
filename string

Padrão para UUID (por exemplo, 0c93bd9e-9ebb-4634-a70f-de9131848416.pdf). Use-o para especificar o nome do arquivo personalizado, ele deve terminar com .pdf

Resample Resample Resample Grande
image_resample_res string

Insiramos as imagens originais por padrão, o que significa tamanhos de arquivo PDF grandes. Especificar a opção 'image_resample_res' ajuda a reduzir o tamanho do arquivo PDF reduzindo as imagens do PDF atual para uma resolução (em DPI). Os valores comuns são 72, 96, 150, 300 e 600.

É CMYK
is_cmyk string

Use o perfil de cor CMYK, 1=true, 0=false. Padrão para '0'

Armazenamento em nuvem
cloud_storage integer

Carregue os PDFs/imagens gerados em nossa CDN de armazenamento, padrão para 1. Se você tiver configurado Post Action para carregar os PDFs/Imagens em seu próprio S3, defina-o como 0.

Meta
meta string

Especifique uma ID de referência externa para sua própria referência. Ele aparece na list-objects API.

Async
async string

0Ou 1 (Padrão). 0 é chamada síncrona(padrão), 1 é chamada assíncrona. Para gerar PDF de forma assíncrona, defina o valor e a chamada à 1 API retorna imediatamente. Depois que o documento PDF for gerado, faremos um HTTP/HTTPS GET para sua URL (webhook_url) e tentaremos novamente por três vezes antes de desistir.. Se async estiver definido como 1, então webhook_url será obrigatório

Webhook URL
webhook_url string

É a URL da URL do webhook, ela começa com http:// ou https:// e precisa ser urlencoded.. Se async estiver definido como 1, você precisará especificar o webhook_url. Formato de retorno de chamada do WebhookOnce que o PDF é gerado, iniciaremos uma chamada HTTP/HTTPS GET para a seguinte URL:https://[yourwebserver.com]?&primary_url=[primary_url]&transaction_ref=[transaction_ref]&status=[status]&message=[message]. [yourwebserver.com]: os serviços Web para lidar com o retorno de chamada, que é o webhook_url. [primary_url]: a URL do documento PDF. [transaction_ref]: o número de referência da transação. [status] : status da transação ou successerror. [message] : mensagem de statusA seguir está uma chamada de webhook de exemplo de volta para seu servidorhttps://yourwebserver.com?& primary_url=https%3A%2F%2Fpub-cdn.apitemplate.io%2F2021%2F06%2Fb692183d-46d7-3213-891a-460a5814ad3f.pdf&transaction_ref=b692183d-46d7-3213-891a-460a5814ad3f&status=success

object

Retornos

ResponseSuccessPDFFile
ResponseSuccessPDFFile

Criar uma imagem

Essa solicitação cria um arquivo JPEG (juntamente com PNG) de dados JSON e seu modelo.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Modelo
template_id True string

Sua ID de modelo, ela pode ser obtida no console Web

Vencimento
expiration integer

Expiração da imagem gerada em minutos(padrão para 0, armazenar permanentemente). Use 0 para armazenar permanentemente na CDN. Ou use o intervalo entre 1 minutos e 10080 minutos (7 dias) para especificar a expiração da imagem gerada

Armazenamento em nuvem
cloud_storage integer

Carregue os PDFs/imagens gerados em nossa CDN de armazenamento e gere uma URL, padrão para 1. Se você configurou a Post ActionsAPI Integration entrada para carregar os PDFs/Imagens gerados em seu próprio S3 privado, defina cloud_storage como 0. Se o export_type=file. por favor, ignore isso.

Tipo de imagem de saída
output_image_type string

Tipo de imagem de saída (formato JPEG ou PNG), padrão para all. As opções são all, jpegOnly,pngOnly.

Meta
meta string

Especifique uma ID de referência externa para sua própria referência. Ele aparece na list-objects API.

object

Retornos

ResponseSuccessImageFile
ResponseSuccessImageFile

Excluir um objeto

Exclua um PDF ou uma imagem da CDN e marque a transação como excluída.

Parâmetros

Nome Chave Obrigatório Tipo Description
Ref de Transação
transaction_ref True string

Referência de transação de objeto

Retornos

ResponseSuccessDeleteObject
ResponseSuccessDeleteObject

Listar modelos

Recupera uma lista dos modelos e suas informações.

Parâmetros

Nome Chave Obrigatório Tipo Description
Limit
limit string

Recupere apenas o número de registros especificados. Padrão para 300

Offset
offset string

O deslocamento é usado para ignorar o número de registros dos resultados. Padrão para 0

Formato
format string

Para filtrar os modelos por 'PDF' ou 'JPEG'

ID do Modelo
template_id string

Para filtrar os modelos por ID de modelo

Nome de Grupo
group_name string

Para filtrar os modelos pelo nome do grupo

Com informações de camada
with_layer_info string

Retorne junto com informações de camada para modelos de imagem, 0=false, 1=true. Padrão para '0'

Retornos

ResponseSuccessListTemplates
ResponseSuccessListTemplates

Listar objetos gerados

Recupera uma lista de todos os PDFs e imagens gerados.

Parâmetros

Nome Chave Obrigatório Tipo Description
Limit
limit string

Recupere apenas o número de registros especificados. Padrão para 300

Offset
offset string

O deslocamento é usado para ignorar o número de registros dos resultados. Padrão para 0

ID do Modelo
template_id string

Filtrado por ID de modelo

Tipo de Transação
transaction_type string

Filtrados por tipo de transação, as opções são PDF, JPEG ou MERGE

Retornos

ResponseSuccessListObjects
ResponseSuccessListObjects

Mesclar vários PDFs

Essa ação mescla/une vários PDF em um único arquivo PDF.

Parâmetros

Nome Chave Obrigatório Tipo Description
Meta
meta string

Especifique uma ID de referência externa para sua própria referência. Ele aparece na list-objects API.

URLs
urls True array of string

Matriz de URL. Damos suporte a URLs http/https normais e URLs de dados. URLs normais: as URLs começam com http/https, por exemplo: "https://fileserver.com/a1.pdf"). URLs de dados: URLs prefixadas com o esquema "data:", por exemplo, "data:application/pdf; base64, JVBERi0xLjIg.. [truncado]"

Tipo de Exportação
export_type string

jsonOu file (Padrão). A opção json retorna um objeto JSON e o PDF de saída é armazenado em uma CDN. A opção file retorna dados binários do PDF gerado (seguro e completamente privado) e o cabeçalho HTTP de resposta Content-Disposition é definido como anexo. Ele tem um limite de tamanho de arquivo de 6 MB.

Vencimento
expiration integer

Expiração do PDF gerado em minutos(padrão para 0, armazenar permanentemente). Use 0 para armazenar permanentemente na CDN. Ou use o intervalo entre 1 minutos e 43200 minutos (30 dias) para especificar a expiração do PDF gerado

Armazenamento em nuvem
cloud_storage integer

Carregue os PDFs/imagens gerados em nossa CDN de armazenamento, padrão para 1. Se você tiver configurado Post Action para carregar os PDFs/Imagens em seu próprio S3, defina-o como 0.

Retornos

ResponseSuccessSingleFile
ResponseSuccessSingleFile

Obter modelo de PDF

Recupera informações sobre o modelo PDF.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Modelo
template_id string

A ID do modelo pode ser obtida no console Web (Gerenciar Modelos)

Retornos

ResponseSuccessTemplate
ResponseSuccessTemplate

Definições

ResponseSuccess

Nome Caminho Tipo Description
Situação
status string

Situação

ResponseSuccessTemplate

Nome Caminho Tipo Description
Situação
status string

Situação

ID do Modelo
template_id string

ID do Modelo

Corpo
body string

Corpo HTML do modelo

CSS
css string

CSS do modelo

Configurações
settings string

Configurações de impressão do modelo

ResponseSuccessPDFFile

Nome Caminho Tipo Description
Situação
status string

Situação

Transferir URL
download_url string

Transferir URL

ID do Modelo
template_id string

ID do Modelo

Ref de Transação
transaction_ref string

Referência de transação

Postar Ações
post_actions array of object

As ações de postagem.

items
post_actions object

ResponseSuccessImageFile

Nome Caminho Tipo Description
Situação
status string

Situação

Transferir URL
download_url string

Transferir URL

Baixar PNG de URL
download_url_png string

Baixar PNG de URL

ID do Modelo
template_id string

ID do Modelo

Ref de Transação
transaction_ref string

Referência de transação

Postar Ações
post_actions array of object

As ações de postagem.

items
post_actions object

ResponseSuccessListTemplates

Nome Caminho Tipo Description
Situação
status string

O status.

Modelos
templates array of object

Os modelos

items
templates object

ResponseSuccessListObjects

Nome Caminho Tipo Description
Situação
status string

O status.

Objetos
objects array of object

Os objetos.

items
objects object

ResponseSuccessDeleteObject

Nome Caminho Tipo Description
Situação
status string

O status.

ResponseSuccessSingleFile

Nome Caminho Tipo Description
Situação
status string

Situação

URL primária
primary_url string

Documento PDF gerado

Ref de Transação
transaction_ref string

Referência de transação