Partilhar via


APITemplate (Editora Independente)

Com o serviço APITemplate.io, você pode criar documentos e imagens PDF e gerenciar seus modelos. Gere imagens de redes sociais, banners ou PDFs a partir de modelos reutilizáveis sem codificação!

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

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , 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 do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do 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)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Troia Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Metadados do conector
Editora Troia Taylor
Sítio Web https://apitemplate.io/
Política de privacidade https://apitemplate.io/privacy-policy/
Categorias Conteúdo e Ficheiros

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 Description Obrigatório
Chave de API securestring A chave de API para esta api Verdade

Limites de Limitação

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

Ações

Atualizar modelo PDF

Esta ação atualiza um modelo PDF.

Criar um PDF

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

Criar uma imagem

Essa solicitação cria um arquivo JPEG (junto com PNG) a partir 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 objetos gerados

Recupera uma lista de todos os PDFs e imagens gerados.

Mesclar vários PDFs

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

Modelos de lista

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

Obter modelo PDF

Recupera informações sobre o modelo PDF.

Atualizar modelo PDF

Esta ação atualiza um modelo PDF.

Parâmetros

Name Chave Necessário Tipo Description
ID do modelo
template_id True string

Seu ID de modelo, ele pode ser obtido no console da web (Gerenciar modelos)

Body
body string

O corpo HTML

CSS
css string

O css

Devoluções

RespostaSucesso
ResponseSuccess

Criar um PDF

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

Parâmetros

Name Chave Necessário Tipo Description
ID do modelo
template_id True string

Seu ID de modelo, ele pode ser obtido no console da web (Gerenciar modelos)

Tipo de exportação
export_type string

ou filejson(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.

Expiração
expiration integer

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

HTML de saída
output_html string

ou 10(padrão).. Para habilitar a saída de conteúdo html, defina o valor como 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 ficheiro
filename string

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

Grande Resample Res
image_resample_res string

Incorporamos as imagens originais por padrão, o que significa grandes tamanhos de arquivo PDF. Especificar a opção 'image_resample_res' ajuda a reduzir o tamanho do arquivo PDF reduzindo a resolução das 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 na Nuvem
cloud_storage integer

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

Meta
meta string

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

Assíncrono
async string

ou 10(padrão). 0 é chamada síncrona (padrão), 1 é chamada assíncrona. Para gerar PDF de forma assíncrona, defina o valor como 1 e a chamada de API retorna imediatamente. Uma vez que o documento PDF é gerado, vamos fazer um HTTP/HTTPS GET para o seu URL (webhook_url) e tentaremos novamente por 3 vezes antes de desistir.. Se async estiver definido como 1, então webhook_url é obrigatório

Webhook URL
webhook_url string

É o URL do seu URL webhook, começa com http:// ou https:// e tem de ser urlencoded.. Se async estiver definido como 1, então você terá que especificar o webhook_url. Formato de retorno de chamada WebhookUma vez que o PDF é gerado, iniciaremos uma chamada HTTP/HTTPS GET para o 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]: O URL para o documento PDF. [transaction_ref]: O número de referência da transação. [status] : Status da transação, ou successerror. [message] : Mensagemde status A seguir está um exemplo de chamada webhook de volta para o 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

Devoluções

ResponseSuccessPDFFile
ResponseSuccessPDFFile

Criar uma imagem

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

Parâmetros

Name Chave Necessário Tipo Description
ID do modelo
template_id True string

Seu ID de modelo, ele pode ser obtido no console da web

Expiração
expiration integer

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

Armazenamento na Nuvem
cloud_storage integer

Carregue os PDFs/imagens gerados para a nossa CDN de armazenamento e gere um URL, padrão para 1. Se você configurou o Post Actions in API Integration para carregar os PDFs/imagens gerados para o 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 um ID de referência externo para sua própria referência. Ele aparece na list-objects API.

object

Devoluções

ResponseSuccessImageFile
ResponseSuccessImageFile

Excluir um objeto

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

Parâmetros

Name Chave Necessário Tipo Description
Transação Ref
transaction_ref True string

Referência de transação de objeto

Devoluções

ResponseSuccessDeleteObject
ResponseSuccessDeleteObject

Listar objetos gerados

Recupera uma lista de todos os PDFs e imagens gerados.

Parâmetros

Name Chave Necessário Tipo Description
Limite
limit string

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

Compensação
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 do modelo

Tipo de Operação
transaction_type string

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

Devoluções

ResponseSuccessListObjects
ResponseSuccessListObjects

Mesclar vários PDFs

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

Parâmetros

Name Chave Necessário Tipo Description
Meta
meta string

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

URLs
urls True array of string

Matriz de URL. Suportamos URLs http/https normais e URLs de dados. URLs normais: os 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

ou filejson(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. Tem um limite de tamanho de ficheiro de 6MB.

Expiração
expiration integer

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

Armazenamento na Nuvem
cloud_storage integer

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

Devoluções

ResponseSuccessSingleFile
ResponseSuccessSingleFile

Modelos de lista

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

Parâmetros

Name Chave Necessário Tipo Description
Limite
limit string

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

Compensação
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 do modelo

Nome do Grupo
group_name string

Para filtrar os modelos pelo nome do grupo

Com informações de camada
with_layer_info string

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

Devoluções

ResponseSuccessListTemplates
ResponseSuccessListTemplates

Obter modelo PDF

Recupera informações sobre o modelo PDF.

Parâmetros

Name Chave Necessário Tipo Description
ID do modelo
template_id string

Seu ID de modelo, ele pode ser obtido no console da web (Gerenciar modelos)

Devoluções

ResponseSuccessTemplate
ResponseSuccessTemplate

Definições

RespostaSucesso

Name Caminho Tipo Description
Situação
status string

Situação

ResponseSuccessTemplate

Name Caminho Tipo Description
Situação
status string

Situação

ID do modelo
template_id string

ID do modelo

Body
body string

Corpo HTML do modelo

CSS
css string

CSS do modelo

Configurações
settings string

Configurações de impressão do modelo

ResponseSuccessPDFFile

Name Caminho Tipo Description
Situação
status string

Situação

Download URL
download_url string

Download URL

ID do modelo
template_id string

ID do modelo

Transação Ref
transaction_ref string

Referência da transação

Pós-Ações
post_actions array of object

As ações de postagem.

items
post_actions object

ResponseSuccessImageFile

Name Caminho Tipo Description
Situação
status string

Situação

Download URL
download_url string

Download URL

Baixar URL PNG
download_url_png string

Baixar URL PNG

ID do modelo
template_id string

ID do modelo

Transação Ref
transaction_ref string

Referência da transação

Pós-Ações
post_actions array of object

As ações de postagem.

items
post_actions object

ResponseSuccessListTemplates

Name Caminho Tipo Description
Situação
status string

O status.

Modelos
templates array of object

Os modelos

items
templates object

ResponseSuccessListObjects

Name Caminho Tipo Description
Situação
status string

O status.

Objects
objects array of object

Os objetos.

items
objects object

ResponseSuccessDeleteObject

Name Caminho Tipo Description
Situação
status string

O status.

ResponseSuccessSingleFile

Name Caminho Tipo Description
Situação
status string

Situação

URL principal
primary_url string

Documento PDF gerado

Transação Ref
transaction_ref string

Referência da transação