Documentos Plumsail
O conector Plumsail Documents permite configurar a geração e conversão automatizada de documentos. O conector fornece uma ampla gama de ações para manipular documentos PDF e formulários PDF. Crie documentos a partir de modelos, converta em PDF, divida e mescle arquivos PDF, proteja-os, leia formulários PDF e muito mais - tudo o que você precisa para automatizar documentos em um conector. Encontre mais informações em https://plumsail.com/documents
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Standard | Todas as regiões Power Automate exceto as seguintes: - 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 China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Standard | Todas as regiões Power Apps exceto as seguintes: - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Standard | Todas as regiões Power Automate exceto as seguintes: - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Support |
| URL | https://plumsail.com |
| support@plumsail.com |
| Metadados do conector | |
|---|---|
| Editora | Vela de ameixa |
| Sítio Web | https://plumsail.com |
| Política de privacidade | https://plumsail.com/privacy-policy/ |
| Categorias | Produtividade; Conteúdo e Ficheiros |
Gerar documentos no Microsoft Power Automate, Azure Logic Apps ou PowerApps
Registar conta
Primeiro de tudo, você precisa registrar a conta Plumsail. Esta conta é usada para gerenciar os produtos Plumsail Documents, Plumsail Actions e Plumsail Forms.
É melhor usar seu endereço de e-mail ativo. A subscrição será associada a este endereço.
Se já tiver uma conta, basta iniciar sessão no account.plumsail.com.
Gerar chave de API
Você precisa navegar até a seção "Chaves de API" e clicar em "Adicionar novo".
Depois de criar uma chave de API, você pode ver sua chave diretamente na coluna "Segredo". Você também pode alterar o nome de uma chave clicando nela na coluna "Nome":
Crie quantas chaves precisares, por exemplo, para usar com diferentes contas do Power Automate (Microsoft Flow). Se você não precisa mais de uma chave, você pode excluí-la, por favor, certifique-se de que a chave não é mais usada.
Agora você pode copiá-lo e usá-lo em:
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 | Compartilhável |
Padrão
Aplicável: Todas as regiões
Parâmetros para criar conexão.
Esta é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, a conexão também será compartilhada. Para mais informações, consulte a visão geral Connectors para aplicações canvas - Power Apps | Microsoft Docs
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| chave de API | securestring | Criar chave de API no account.plumsail.com | Verdade |
| Localização do datacenter | cadeia (de caracteres) |
Limites de Limitação
| Nome | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 1200 | 60 segundos |
Ações
Adicionar uma marca d'água ao PDF
Adicione uma marca de água ao PDF como texto, imagem, HTML ou PDF. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#add-watermark-to-pdf
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Tipo
|
type | True | string |
O tipo da marca d'água |
|
pedido
|
request | True | dynamic |
Devoluções
Analisar CSV
Analisar CSV funciona como analisar JSON, mas para arquivos CSV. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#parse-csv
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Conteúdo do documento CSV
|
content | True | byte |
Conteúdo do documento CSV |
|
Delimitador
|
delimiter | string |
Delimitador de colunas (por padrão é apenas vírgula) |
|
|
Localidade
|
locale | string |
A localidade que será aplicada ao documento |
|
|
Limite
|
limit | integer |
Devolve as primeiras "n" linhas |
|
|
Headers
|
headers | True | string |
Lista de cabeçalhos separados por vírgulas na mesma ordem das colunas CSV |
|
Pule a primeira fila
|
skipFirstLine | boolean |
Selecione "Sim" se o CSV tiver cabeçalhos como primeira linha. |
Devoluções
Comprimir documento PDF
Comprima o tamanho do documento PDF, se possível, e otimize-o. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#compress-pdf-document
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Conteúdo do documento
|
documentContent | True | byte |
Conteúdo bruto do documento PDF |
|
Modo sem perdas
|
losslessMode | string |
Quando desativado, comprime o ficheiro PDF de forma mais eficaz, mas com uma ligeira perda de qualidade de imagem. |
|
|
Palavra-passe
|
password | string |
Senha para abrir arquivo PDF |
Devoluções
- Arquivo de resultados
- binary
Converter CSV para Excel
Converter CSV para arquivo Excel (XLSX). Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#csv-to-excel
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Conteúdo do documento CSV
|
content | True | byte |
Conteúdo do documento CSV |
|
Delimitador
|
delimiter | string |
Delimitador de colunas (por padrão é apenas vírgula) |
|
|
Localidade
|
locale | string |
A localidade que será aplicada ao documento |
|
|
Limite
|
limit | integer |
Devolve as primeiras "n" linhas |
|
|
Usar a primeira linha como cabeçalhos
|
hasHeaderRecords | boolean |
Se definido como "Sim", os cabeçalhos serão lidos a partir da primeira linha. |
|
|
Nome ou índice da coluna CSV
|
csvColumnIndexOrName | True | string |
Nome da coluna CSV ou índice de coluna (1, 2, etc.) |
|
Tipo de coluna XLSX
|
xlsxColumnType | string |
Opcional. Tipo de coluna (ShortDateTime, TwoDecimal, etc.) |
|
|
Nome da coluna XLSX
|
xlsxColumnName | string |
Opcional. Renomeie a coluna CSV para este nome |
Devoluções
- Arquivo de resultados
- binary
Converter DOC em DOCX
Converta arquivos DOC para DOCX. Esta ação usa o documento DOC e o converte em DOCX. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-doc-to-docx
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Conteúdo do documento
|
documentContent | True | byte |
Conteúdo do documento a converter |
Devoluções
- Arquivo de resultados
- binary
Converter DOCX para PDF
Converta DOCX para ficheiros PDF. Esta ação utiliza o documento DOCX e converte-o em PDF. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-docx-to-pdf
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Conteúdo do documento
|
documentContent | True | byte |
Conteúdo do documento a converter |
Devoluções
Converter Email para PDF
Converter o email fornecido em ficheiro PDF. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-email-to-pdf
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Enviar Conteúdo por E-mail
|
documentContent | True | byte |
Conteúdo do email que deve ser convertido |
|
Mesclar anexos
|
mergeAttachments | True | boolean |
Se os anexos devem ser convertidos para PDF e incluídos no ficheiro de saída |
Devoluções
- Arquivo de resultados
- binary
Converter HTML para DOCX
Converter HTML para documento DOCX. Esta ação usa marcação HTML, renderiza-a e converte em documento DOCX. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-html-to-docx
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Conteúdo do Ficheiro
|
fileContent | binary |
Conteúdo binário do arquivo HTML para converter em DOCX |
|
|
Dados HTML
|
rawHtml | string |
Dados HTML para converter em DOCX |
|
|
HTML URL
|
htmlUrl | string |
URL para a página web para converter em DOCX |
|
|
Tamanho do papel
|
paperSize | string |
Pode ser A4, A5 etc ... |
|
|
Orientação
|
orientation | string |
Retrato ou paisagem |
|
|
Decodificar HTML
|
decodeHtml | boolean |
Se o HTML deve ser decodificado antes da conversão |
|
|
Margens
|
margins | string |
Margens da página em pt. A sintaxe é a mesma que em CSS. Exemplo: 25 50 75 100. |
Devoluções
Converter HTML para PDF
Converter HTML em arquivo PDF. Esta ação usa marcação HTML, renderiza-a e converte em documento PDF. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-html-to-pdf
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
HTML de origem
|
html | True | string |
Marcação HTML que deve ser convertida em PDF |
|
Engine
|
engine | string |
Motor de conversão |
|
|
Tamanho do papel
|
size | string |
Pode ser A4, A5 etc ... |
|
|
Orientação
|
orientation | string |
Retrato ou paisagem |
|
|
Margens
|
margins | string |
As margens da página. A sintaxe é a mesma que em CSS. Exemplo: 25 50 75 100. |
|
|
HTML do cabeçalho
|
headerHtml | string |
Marcação HTML que deve ser adicionada como cabeçalho |
|
|
Rodapé HTML
|
footerHtml | string |
Marcação HTML que deve ser adicionada como rodapé |
Devoluções
Converter imagens em PDF
Tira imagens e converte-as num documento PDF
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Imagem única por página
|
imagePerPage | boolean |
Selecione "Não" se não quiser que cada imagem esteja em uma página separada. O padrão é "Sim" |
|
|
Conteúdo da imagem
|
imageContent | True | array of byte |
Conteúdo bruto da imagem |
Devoluções
- Arquivo de resultados
- binary
Converter JSON em CSV
Converta JSON para arquivo CSV. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#json-to-csv
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Conteúdo do arquivo JSON
|
content | byte |
Opcional. Conteúdo do ficheiro JSON |
|
|
Dados JSON
|
jsonData | string |
Opcional. Dados JSON a serem processados |
|
|
Localidade
|
locale | string |
A localidade que será aplicada ao documento |
|
|
Caminho para a matriz JSON
|
pathToJsonArray | string |
Caminho separado por pontos para a matriz em JSON. Por exemplo: "dados" ou "prop1.prop2.prop3" |
|
|
Delimitador
|
delimiter | string |
Delimitador de colunas em CSV. O padrão é vírgula |
Devoluções
- Arquivo de resultados
- binary
Converter JSON para Excel
Converter JSON para arquivo Excel (XLSX). Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#json-to-excel
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Conteúdo do arquivo JSON
|
content | byte |
Opcional. Conteúdo do ficheiro JSON |
|
|
Dados JSON
|
jsonData | string |
Opcional. Dados JSON a serem processados |
|
|
Localidade
|
locale | string |
A localidade que será aplicada ao documento |
|
|
Caminho para a matriz JSON
|
pathToJsonArray | string |
Caminho separado por pontos para a matriz em JSON. Por exemplo: "dados" ou "prop1.prop2.prop3" |
|
|
Propriedade JSON
|
jsonProperty | True | string |
Nome da propriedade JSON |
|
Tipo de coluna XLSX
|
xlsxColumnType | string |
Opcional. Tipo de coluna (ShortDateTime, TwoDecimal, etc.) |
|
|
Nome da coluna XLSX
|
xlsxColumnName | string |
Opcional. Renomeie a propriedade JSON para este nome |
Devoluções
- Arquivo de resultados
- binary
Converter para PDF
Converter o ficheiro fornecido em ficheiro PDF. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-to-pdf
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Conteúdo do documento
|
documentContent | True | byte |
Conteúdo do documento a converter |
Devoluções
- Arquivo de resultados
- binary
Converter para PDF (obsoleto) [OBSOLETO]
Esta ação foi preterida. Por favor, use o Converter para PDF em vez disso.
Converter o ficheiro fornecido em ficheiro PDF. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-to-pdf (preterido)
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Conteúdo do documento
|
documentContent | True | byte |
Conteúdo do documento a converter |
|
Nome do ficheiro
|
filename | True | string |
Nome completo do ficheiro a converter. Incluindo extensão de ficheiro |
Devoluções
- Arquivo de resultados
- binary
Converter PDF em Imagem
Converta PDF em imagem. Esta ação pega o documento PDF e o converte em Imagem (jpeg, png, gif, bmp, etc). Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-pdf-to-image
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Conteúdo do documento
|
documentContent | True | byte |
Conteúdo bruto do documento PDF |
|
Prefixo do nome do arquivo
|
filenamePrefix | string |
Opcional. Os arquivos de saída terão esse prefixo seguido por um número de índice para o nome |
|
|
Página inicial
|
startPage | integer |
A primeira página para iniciar a extração (1 baseado) |
|
|
Fim da página
|
endPage | integer |
A última página a extrair (inclusive) |
|
|
Páginas
|
pages | string |
Números de página para extração separados por ';' (apenas esta página será extraída) |
|
|
Formato de imagem
|
format | string |
O formato da imagem do resultado |
|
|
DPI
|
dpi | integer |
A resolução da imagem resultante |
|
|
Palavra-passe
|
password | string |
Palavra-passe para desencriptar o documento |
Devoluções
Converter PDF em Imagem (preterido) [PRETERIDO]
Esta ação foi preterida. Em vez disso, use Converter PDF em Imagem .
Converta PDF em imagem. Esta ação pega o documento PDF e o converte em Imagem (jpeg, png, gif, bmp, etc). Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-pdf-to-image (preterido)
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Conteúdo do documento
|
documentContent | True | byte |
Conteúdo bruto do documento PDF |
|
Página inicial
|
startPage | integer |
A primeira página para iniciar a extração (1 baseado) |
|
|
Fim da página
|
endPage | integer |
A última página a extrair (inclusive) |
|
|
Páginas
|
pages | string |
Números de página para extração separados por ';' (apenas esta página será extraída) |
|
|
Formato de imagem
|
format | string |
O formato da imagem do resultado |
|
|
DPI
|
dpi | integer |
A resolução da imagem resultante |
|
|
Palavra-passe
|
password | string |
Palavra-passe para desencriptar o documento |
Devoluções
Converter PPT para PPTX
Converter PPT para arquivos PPTX. Esta ação usa o documento PPT e o converte em PPTX. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-ppt-to-pptx
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Conteúdo do documento
|
documentContent | True | byte |
Conteúdo do documento a converter |
Devoluções
- Arquivo de resultados
- binary
Converter PPTX para PDF
Converta PPTX para arquivos PDF. Esta ação usa o documento PPTX e o converte em PDF. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-pptx-to-pdf
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Conteúdo do documento
|
documentContent | True | byte |
Conteúdo do documento a converter |
Devoluções
- Arquivo de resultados
- binary
Converter XLS para XLSX
Converta arquivos XLS para XLSX. Esta ação usa o documento XLS e o converte em XLSX. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-xls-to-xlsx
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Conteúdo do documento
|
documentContent | True | byte |
Conteúdo do documento a converter |
Devoluções
- Arquivo de resultados
- binary
Converter XLSX para PDF
Converta XLSX para arquivos PDF. Esta ação usa o documento XLSX e o converte em PDF. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-xlsx-to-pdf
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Conteúdo do documento
|
documentContent | True | byte |
Conteúdo do documento a converter |
Devoluções
- Arquivo de resultados
- binary
Correspondência de expressão regular
A Correspondência de Expressão Regular procura uma cadeia de caracteres de entrada para todas as ocorrências de uma expressão regular e retorna todas as correspondências. Recomendamos usar Regex Hero para testar suas expressões. Ele suporta a mesma sintaxe que as ações. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#regular-expression-match
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Padrão
|
pattern | True | string |
Padrão de expressão regular |
|
Texto
|
text | True | string |
String para procurar correspondências |
Devoluções
Criar Arquivo
Comprime e adiciona ficheiros a um arquivo ZIP.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Nome do ficheiro
|
fileName | True | string |
Nome do arquivo sem a extensão do arquivo |
|
Nome do ficheiro
|
fileName | string |
Nome do arquivo, incluindo a extensão do arquivo |
|
|
Conteúdo do ficheiro
|
content | binary |
Conteúdo do documento |
|
|
Palavra-passe
|
password | string |
Arquivar palavra-passe |
Devoluções
Criar documento a partir do modelo DOCX
Crie um documento a partir do modelo DOCX. Mais informações: https://plumsail.com/docs/documents/v1.x/document-generation/docx/index.html
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Arquivo de modelo
|
documentContent | True | binary |
Conteúdo do modelo |
|
Dados do modelo
|
data | True | object |
Dados JSON que devem ser aplicados ao modelo |
|
Tipo de saída do documento
|
outputType | True | string |
O tipo de documento necessário |
|
Localidade
|
locale | string |
A localidade que será aplicada ao documento |
|
|
Fuso horário
|
timezone | string |
O fuso horário do documento |
|
|
Motor de templates
|
engine | string |
O motor que irá processar o modelo |
Devoluções
- Arquivo de resultados
- binary
Criar documento a partir do modelo PPTX
Crie um documento a partir do modelo PPTX. Mais informações: https://plumsail.com/docs/documents/v1.x/document-generation/pptx/index.html
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Arquivo de modelo
|
documentContent | True | binary |
Conteúdo do modelo |
|
Dados do modelo
|
data | True | object |
Dados JSON que devem ser aplicados ao modelo |
|
Tipo de saída do documento
|
outputType | True | string |
O tipo de documento necessário |
|
Localidade
|
locale | string |
A localidade que será aplicada ao documento |
|
|
Fuso horário
|
timezone | string |
O fuso horário do documento |
Devoluções
Criar documento a partir do modelo XLSX
Crie um documento a partir do modelo XLSX. Mais informações: https://plumsail.com/docs/documents/v1.x/document-generation/xlsx/index.html
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Arquivo de modelo
|
documentContent | True | binary |
Conteúdo do modelo |
|
Dados do modelo
|
data | True | object |
Dados JSON que devem ser aplicados ao modelo |
|
Tipo de saída do documento
|
outputType | True | string |
O tipo de documento necessário |
|
Localidade
|
locale | string |
A localidade que será aplicada ao documento |
|
|
Fuso horário
|
timezone | string |
O fuso horário do documento |
|
|
Motor de templates
|
engine | string |
O motor que irá processar o modelo |
Devoluções
- Arquivo de resultados
- binary
Criar HTML a partir do modelo
Create HTML usa a cadeia de caracteres ou arquivo de modelo HTML de entrada e substitui {{Tokens}} especial por dados especificados. Usamos a estrutura Mustache para modelos internamente. Mais informações sobre modelos em documentos do Bigode: http://mustache.github.io/mustache.5.html. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#create-html-from-template
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
HTML de origem
|
html | True | byte |
Modelo HTML de texto ou modelo de arquivo HTML |
|
Dados do modelo
|
data | True | object |
Dados JSON que devem ser aplicados ao modelo |
|
Localidade
|
locale | string |
A localidade que será aplicada ao documento |
|
|
Fuso horário
|
timezone | string |
O fuso horário do documento |
Devoluções
Dividir PDF
Dividir PDF pega documento PDF e o divide. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#split-pdf
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Tipo de divisão
|
type | True | string |
Como dividir o arquivo |
|
pedido
|
request | True | dynamic |
Devoluções
Dividir PDF (preterido) [PRETERIDO]
Esta ação foi preterida. Em vez disso, use Split PDF .
Pega num documento PDF e divide-o (preterido)
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Conteúdo do documento
|
documentContent | True | byte |
Conteúdo bruto do documento PDF |
|
Página inicial
|
startPage | integer |
A primeira página para iniciar a divisão (1 baseado) |
|
|
Fim da página
|
endPage | integer |
A última página a dividir (inclusive) |
|
|
Dividir na página
|
splitAtPage | integer |
Número de páginas por partição |
|
|
Palavra-passe
|
password | string |
Palavra-passe para desencriptar o documento |
Devoluções
Expressão regular substituir
A Substituição de Expressão Regular substitui todas as cadeias de caracteres que correspondem a um padrão de expressão regular por uma cadeia de caracteres de substituição especificada em uma cadeia de caracteres de entrada especificada. Recomendamos usar Regex Hero para testar suas expressões. Ele suporta a mesma sintaxe que as ações. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#regular-expression-replace
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Padrão
|
pattern | True | string |
Padrão de expressão regular |
|
Texto
|
text | True | string |
String para procurar correspondências |
|
Replacement
|
replacement | string |
String de substituição |
Devoluções
- Body
- StringResultResponse
Extrair Arquivo
Extraia arquivos do arquivo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Arquivo morto
|
fileContent | byte |
Conteúdo do ficheiro de arquivo |
|
|
Incluir pastas
|
includeFolders | boolean |
Se os arquivos 'verdadeiros' contidos nas pastas serão extraídos |
|
|
Palavra-passe
|
password | string |
Arquivar palavra-passe |
Devoluções
Extrair texto do documento PDF
Extrair texto de PDF leva documento PDF e extrai texto para o formato Raw ou HTML. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#extract-text-from-pdf-document
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Conteúdo do documento
|
documentContent | True | byte |
Conteúdo bruto do documento PDF |
|
Página inicial
|
startPage | integer |
A primeira página para iniciar a extração (1 baseado) |
|
|
Fim da página
|
endPage | integer |
A última página a extrair (inclusive) |
|
|
Tipo de resultado
|
resultType | string |
Raw ou HTML |
|
|
Palavra-passe
|
password | string |
Palavra-passe para desencriptar o documento |
Devoluções
Fusão de ficheiros DOCX
Merge ficheiros DOCX pega num conjunto de documentos Docx e junta-os num único ficheiro. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#merge-docx-files
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Content
|
documentsContents | True | array of binary |
A matriz de conteúdo bruto de documentos Docx |
|
Aplicar cabeçalho e rodapé
|
applyHeaderAndFooter | True | boolean |
Aplica o cabeçalho e rodapé do primeiro documento a todos os outros. Ignorado quando "Adicionar quebra de página" é Não (força Sim). |
|
Adicionar quebra de página
|
addPageBreak | boolean |
Adiciona quebras de página entre documentos fundidos. |
Devoluções
Fusão de ficheiros XLSX
Merge ficheiros XLSX pega numa matriz de documentos XLSX e junta-os num único ficheiro. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#merge-xlsx-files
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Content
|
documentsContents | True | array of binary |
A matriz de conteúdo bruto de documentos Xlsx |
Devoluções
Iniciar o processo de geração de documentos
Iniciar processo de geração de documentos preenche um modelo DOCX, XLSX, PPTX ou PDF relacionado ao processo selecionado com os dados JSON. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#start-document-generation-process
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Nome do processo
|
processId | True | string |
O nome do processo a ser iniciado |
|
Ficheiros de saída como
|
outputFilesAs | True | string |
Escolha se os ficheiros de saída são devolvidos como variáveis separadas ou como um array de ficheiros |
|
dados
|
data | True | dynamic |
Devoluções
Iniciar o processo de geração de documentos com json
Iniciar processo de geração de documentos preenche um modelo DOCX, XLSX, PPTX ou PDF relacionado ao processo selecionado com os dados JSON. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html##start-process-json
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Nome do processo
|
processId | True | string |
O nome do processo a ser iniciado |
|
Ficheiros de saída como
|
outputFilesAs | True | string |
Escolha se os ficheiros de saída são devolvidos como variáveis separadas ou como um array de ficheiros |
|
|
object |
Devoluções
Iniciar o processo de geração de documentos com json [OBSOLETADO]
Esta ação foi preterida. Por favor, utilize o processo Start de geração de documentos com json em vez disso.
Iniciar processo de geração de documentos preenche um modelo DOCX, XLSX, PPTX ou PDF relacionado ao processo selecionado com os dados JSON. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html##start-process-json
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Nome do processo
|
processId | True | string |
O nome do processo a ser iniciado |
|
|
object |
Devoluções
- Arquivo de resultados
- binary
Iniciar processo de geração de documentos (obsoleto) [OBSOLETO]
Esta ação foi preterida. Por favor, utilize antes o processo iniciar geração de documentos .
Iniciar processo de geração de documentos preenche um modelo DOCX, XLSX, PPTX ou PDF relacionado ao processo selecionado com os dados JSON. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#start-document-generation-process (preterido)
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Nome do processo
|
processId | True | string |
O nome do processo a ser iniciado |
|
dados
|
data | True | dynamic |
Devoluções
- Arquivo de resultados
- binary
Juntar quaisquer ficheiros em PDF
Converte e junta vários ficheiros num único documento PDF. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#merge-any-files-into-pdf
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Content
|
documentsContents | True | array of binary |
O conjunto de conteúdos brutos dos ficheiros a fundir |
|
Gerar Favoritos
|
generateBookmarks | boolean |
Gerar um favorito para cada ficheiro fundido |
|
|
Preservar Favoritos
|
preserveBookmarks | boolean |
Preservar os favoritos de cada PDF fundido |
Devoluções
- Arquivo de resultados
- binary
Juntar quaisquer ficheiros em PDF (obsoleto) [OBSOLETO]
Esta ação foi preterida. Por favor, use o Merge quaisquer ficheiros em PDF .
Converte e junta vários ficheiros num único documento PDF. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#merge-any-files-into-pdf (preterido)
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Nome do ficheiro
|
fileName | True | string |
Nome do ficheiro, incluindo extensão |
|
Conteúdo do Ficheiro
|
content | True | binary |
Conteúdo do ficheiro |
|
Gerar Favoritos
|
generateBookmarks | boolean |
Gerar um favorito para cada ficheiro fundido |
|
|
Preservar Favoritos
|
preserveBookmarks | boolean |
Preservar os favoritos de cada PDF fundido |
Devoluções
- Arquivo de resultados
- binary
Merge PDF (obsoleto) [DESCONTINUADO]
Esta ação foi preterida. Por favor, use o Merge quaisquer ficheiros em PDF .
Mesclar PDF pega uma matriz de documentos PDF e mescla-a em um. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#merge-pdf (preterido)
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Content
|
documentsContents | True | array of binary |
A matriz de conteúdo bruto de documentos PDF |
Devoluções
- Arquivo de resultados
- binary
Obter formulário a partir de PDF
Obter formulário de PDF retorna dados de formulário preenchíveis de PDF como JSON. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#get-form-from-pdf
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Conteúdo do documento
|
documentContent | True | byte |
Conteúdo bruto do documento PDF |
|
Palavra-passe
|
password | string |
Palavra-passe para desencriptar o documento |
Devoluções
- response
- object
Obter informações do perfil
Obter informações de perfil retorna informações sobre o usuário atual e a licença.
Devoluções
- Body
- ProfileInfo
Obter informações sobre a proteção de PDF
Obter informações sobre a proteção de PDF retorna informações se o documento está protegido por senha. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#get-pdf-protection-information
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Conteúdo do documento
|
documentContent | True | byte |
Conteúdo bruto do documento PDF |
Devoluções
Preencha o formulário PDF
Preencha o formulário PDF preenche o PDF a partir dos dados fornecidos. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#fill-in-pdf-form
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Conteúdo do documento
|
documentContent | True | byte |
Conteúdo bruto do documento PDF |
|
Dados JSON
|
jsonData | True | object |
Os dados que serão utilizados para preencher o formulário |
|
Bloquear campos de formulário
|
lockFormFields | boolean |
Desativar a edição de campos depois de preenchê-los |
|
|
Palavra-passe
|
password | string |
Senha para abrir arquivo PDF |
Devoluções
Preencher campos de mesclagem no documento DOCX
Preencher campos de mesclagem no documento DOCX pega um documento DOCX com campos de mesclagem e os substitui por dados especificados. As chaves no objeto de dados devem ser as mesmas que os nomes de MergeFields (bloco Express) no documento. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#fill-merge-fields-in-docx-document
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Conteúdo do documento DOCX
|
docxDocument | True | byte |
Conteúdo bruto do modelo de documento docx. Os nomes de MergeField devem ser os mesmos que as chaves nos dados do modelo |
|
Dados do modelo
|
data | True | object |
Dados JSON que devem ser aplicados ao modelo |
Devoluções
Proteger documento PDF
Proteger documento PDF adiciona senhas, cópia, impressão e outras proteções aos arquivos PDF. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#protect-pdf-document
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Conteúdo do documento
|
documentContent | True | byte |
Conteúdo bruto do documento PDF |
|
Ativar impressão
|
allowPrinting | True | boolean |
Proteja o arquivo PDF de ser impresso |
|
Ativar modificação
|
allowModification | True | boolean |
Proteja o arquivo PDF de ser editado |
|
Ativar dados de extração
|
allowExtract | True | boolean |
Permite a extração de texto, imagens e outras mídias do arquivo PDF |
|
Ativar anotação
|
allowAnnotate | True | boolean |
Permite anotações (por exemplo, comentários, preenchimento de formulários, assinatura) do arquivo PDF |
|
Palavra-passe do proprietário do PDF
|
newOwnerPassword | string |
Introduza aqui uma palavra-passe de proprietário opcional. Esta palavra-passe pode ser utilizada para desativar as restrições de documentos |
|
|
Palavra-passe de utilizador PDF
|
newUserPassword | string |
Introduza aqui uma palavra-passe de utilizador opcional. Cada vez que um utilizador abre o PDF ser-lhe-á pedida esta palavra-passe. Se você não quiser um prompt de senha, deixe este campo em branco |
|
|
Palavra-passe
|
password | string |
Palavra-passe para desencriptar o documento |
Devoluções
Teste de Expressão Regular
Teste de expressão regular indica se a expressão regular especificada no construtor Regex encontra uma correspondência em uma cadeia de caracteres de entrada especificada. Recomendamos usar Regex Hero para testar suas expressões. Ele suporta a mesma sintaxe que as ações. Documentação - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#regular-expression-test
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Padrão
|
pattern | True | string |
Padrão de expressão regular |
|
Texto
|
text | True | string |
String para procurar correspondências |
Devoluções
Acionadores
| Processo concluído |
Cria um webhook que é executado quando o processo é concluído |
| Processo concluído (obsoleto) [OBSOLETO] |
Esta ação foi preterida. Por favor, utilize Process finished em vez disso.
|
Processo concluído
Cria um webhook que é executado quando o processo é concluído
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Nome do processo
|
processId | True | string |
Nome do processo que, quando terminado, irá desencadear o fluxo |
|
Ficheiros de saída como
|
outputFilesAs | True | string |
Escolha se os ficheiros de saída são devolvidos como variáveis separadas ou como um array de ficheiros |
Devoluções
Processo concluído (obsoleto) [OBSOLETO]
Esta ação foi preterida. Por favor, utilize Process finished em vez disso.
Cria um webhook que corre quando o processo termina (obsoleto)
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Nome do processo
|
processId | True | string |
Nome do processo que, quando terminado, irá desencadear o fluxo |
Devoluções
Definições
ApplyHtmlTemplateResponse
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Resultado HTML
|
htmlResult | string |
Resultado HTML bruto |
BooleanResultResponse
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
IsSuccess
|
isSuccess | boolean |
DocumentContentWithFilenameResponse
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Nome do ficheiro
|
filename | string |
Nome do ficheiro |
|
Conteúdo do Ficheiro
|
fileContent | byte |
Conteúdo do ficheiro |
DocumentProcessingResponse
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Arquivo de resultados
|
fileContent | byte |
O resultado como um arquivo |
DocumentsArrayResponse
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Ficheiros de resultados
|
resultFilesContents | array of byte |
A matriz de conteúdo bruto de arquivos de resultado |
DocumentsWithFilenamesResponse
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Ficheiros de resultados
|
resultFiles | array of DocumentContentWithFilenameResponse |
Matriz de conteúdo bruto de arquivos de resultado com seus nomes de arquivo |
GetPdfProtectionInfoResponse
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
isPasswordProtected
|
isPasswordProtected | boolean |
LicenseInfo
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
tipo
|
type | integer | |
|
credits
|
credits | integer | |
|
adicionaisCréditos
|
additionalCredits | integer | |
|
Data de expiração
|
expirationDate | date-time |
ProfileInfo
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
nome
|
name | string | |
|
e-mail
|
string | ||
|
licenseStatus
|
licenseStatus | string | |
|
Nome da equipa
|
teamName | string | |
|
licenseInfo
|
licenseInfo | LicenseInfo | |
|
shortUserId
|
shortUserId | string |
StringResultResponse
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Result
|
result | string |
binário
Este é o tipo de dados básico 'binário'.
objecto
Este é o tipo 'objeto'.