Jaa

CraftMyPDF (Independent Publisher)

  • Reference

CraftMyPDF's drag & drop editor lets you design PDF templates in any browser and generate pixel-perfect PDF documents from reusable templates and JSON data.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions
Power Automate Premium All Power Automate regions
Power Apps Premium All Power Apps regions
Contact
Name Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Connector Metadata
Publisher Troy Taylor
Website https://craftmypdf.com/
Privacy policy https://craftmypdf.com/privacy-policy/
Categories Content and Files

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
ApiKeyAuth securestring The ApiKeyAuth for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Add watermark

This action adds a watermark to a PDF.
Create a new template

This action creates a new template from a template ID.
Create a PDF

This action creates a PDF file with JSON data and your template.
Create a PDF from multiple templates

This action creates a PDF file from multiple templates. It merges all the PDFs into one.
Create editor session

This action creates a new PDF editor session. The PDF editor url can be embedded into an IFrame.
Delete template

This action deletes a template.
Get account info

This action returns the account information.
List templates

This action lists all your PDF templates.
List transactions

This action lists all the transactions.
Merge PDFs

This action merges multiple PDF URLs.
Update template

This action updates the specified PDF template.

Add watermark

Operation ID:
Add-watermark

This action adds a watermark to a PDF.

Parameters

Name Key Required Type Description
url
 url True string

The URL of the source PDF.
text
 text True string

The watermark text.
font_size
 font_size integer

The font size of the watermark. Default is 40.
opacity
 opacity integer

The opacity of the watermark. Default is 0.5.
rotation
 rotation integer

The rotation of the watermark. Default is 45.
hex_color
 hex_color string

THe color of the watermark, it has to be a hex color and starts with '#'. Default is '#c7c7c7'.
font_family
 font_family string

The font family of the watermark. Default is Helvetica. Available fonts are: Courier, Courier-Bold, Courier-Oblique, Courier-BoldOblique, Helvetica, Helvetica-Bold, Helvetica-Oblique, Helvetica-BoldOblique, Times-Roman, Times-Bold, Times-Italic, Times-BoldItalic, Symbol, ZapfDingbats,
expiration
 expiration integer

The expiration of the generated PDF in minutes. Default is 5 minutes, range between 1 minute and 24 hours.
output_file
 output_file string

The output file, Default is 'output.pdf'.

Returns

ResponseSuccessSingleFile
ResponseSuccessSingleFile

Create a new template

Operation ID:
New-template-from

This action creates a new template from a template ID.

Parameters

Name Key Required Type Description
template_id
 template_id True string

The PDF template ID.
name
 name string

The name of the new template.

Returns

ResponseSuccessCreateNewTemplate
ResponseSuccessCreateNewTemplate

Create a PDF

Operation ID:
Create

This action creates a PDF file with JSON data and your template.

Parameters

Name Key Required Type Description
data
 data True string

The JSON data.
template_id
 template_id True string

The PDF Template ID.
export_type
 export_type string

Either file or json. - The option json returns a JSON object, and the output PDF is stored on a CDN(until expiration). - The option file returns binary data of the generated PDF(More secure and completely private) and the response HTTP header Content-Disposition is set to attachment.
expiration
 expiration integer

The expiration of the generated PDF in minutes. Default is 5 minutes, range between 1 minute and 24 hours.
output_file
 output_file string

The output file. Default is 'output.pdf'.
is_cmyk
 is_cmyk boolean

Use CMYK color profile, Default is 'false'.

Returns

ResponseSuccessSingleFile
ResponseSuccessSingleFile

Create a PDF from multiple templates

Operation ID:
Create-merge

This action creates a PDF file from multiple templates. It merges all the PDFs into one.

Parameters

Name Key Required Type Description
templates
 templates object
export_type
 export_type string

Either file or json. The option json returns a JSON object, and the output PDF is stored on a CDN(until expiration). The option file returns binary data of the generated PDF(More secure and completely private) and the response HTTP header Content-Disposition is set to attachment.
expiration
 expiration integer

Thexpiration of the generated PDF in minutes. Default is 5 minutes, range between 1 minute and 24 hours.
output_file
 output_file string

The output file. Default is 'output.pdf'.
paging
 paging string

It detemines the paging for the next PDF, either is 'continuous' or 'reset' . Default is 'reset' - continuous : The expression {{sys.totalPages}} is the sum of the merged PDF and the {{sys.pageNumber}} continue from the last PDF page number. - reset: The expression {{sys.totalPages}} is the total pages of current PDF and the {{sys.pageNumber}} auto-reset to zero in the next PDF.

Returns

ResponseSuccessSingleFile
ResponseSuccessSingleFile

Create editor session

Operation ID:
Create-editor-session

This action creates a new PDF editor session. The PDF editor url can be embedded into an IFrame.

Parameters

Name Key Required Type Description
template_id
 template_id True string

The PDF Template ID.
expiration
 expiration object

The expiration of the editor session in minutes. Default is 1440 minutes (24 hours).
canSave
 canSave boolean

Can save the template. Default is true.
canCreatePDF
 canCreatePDF boolean

Can Generate PDF. Default is true.
canViewSettings
 canViewSettings boolean

Can view settings. Default is true.
canPreview
 canPreview boolean

Can preview. Default is true.
canEditJSON
 canEditJSON boolean

Can edit JSON. Default is true.
canShowHeader
 canShowHeader boolean

Show CraftMyPDF header. Default is true.
jsonMode
 jsonMode integer

JSON editor - 1, JSON viewer - 2. Default is 1.
backURL
 backURL string

The URL for the back button.

Returns

ResponseSuccessCreateNewEditorSession
ResponseSuccessCreateNewEditorSession

Delete template

Operation ID:
Delete-template

This action deletes a template.

Parameters

Name Key Required Type Description
Template ID
 template_id True string

The PDF template ID.

Returns

ResponseSuccessDeleteTemplate
ResponseSuccessDeleteTemplate

Get account info

Operation ID:
Get-account-info

This action returns the account information.

Returns

ResponseAccountInformation
ResponseAccountInformation

List templates

Operation ID:
List-templates

This action lists all your PDF templates.

Parameters

Name Key Required Type Description
Limit
 limit integer

Retrieve only the number of records specified. Default is 300.
Offset
 offset integer

Offset is used to skip the number of records from the results. Default is 0.

Returns

ResponseListTemplate
ResponseListTemplate

List transactions

Operation ID:
List-transactions

This action lists all the transactions.

Parameters

Name Key Required Type Description
Limit
 limit integer

Retrieve only the number of records specified. Default is 300
Offset
 offset integer

Offset is used to skip the number of records from the results. Default is 0

Returns

ResponseListTransactions
ResponseListTransactions

Merge PDFs

Operation ID:
Merge-pdfs

This action merges multiple PDF URLs.

Parameters

Name Key Required Type Description
urls
 urls object
expiration
 expiration integer

The expiration of the generated PDF in minutes. Default is 5 minutes, range between 1 minute and 24 hours.
output_file
 output_file string

The output file. Default is 'output.pdf'.

Returns

ResponseSuccessSingleFile
ResponseSuccessSingleFile

Update template

Operation ID:
Update-template

This action updates the specified PDF template.

Parameters

Name Key Required Type Description
template_id
 template_id True string

The template ID.
name
 name string

Optional, name of the template.
json
 json string

Optional, sample JSON data for the template.

Returns

ResponseUpdateTemplate
ResponseUpdateTemplate

Definitions

ResponseSuccessSingleFile

Name Path Type Description
status
 status string

Status
file
 file string

The generated PDF document.
transaction_ref
 transaction_ref string

The transaction reference.

ResponseListTemplate

Name Path Type Description
status
 status string

The status.
templates
 templates array of object

The array of templates.
items
 templates object

ResponseSuccessCreateNewTemplate

Name Path Type Description
status
 status string

Status
template_id
 template_id string

The generated PDF document.

ResponseSuccessDeleteTemplate

Name Path Type Description
status
 status string

The status.

ResponseListTransactions

Name Path Type Description
status
 status string

The status.
transactions
 transactions array of object

The array of transactions.
items
 transactions object

ResponseAccountInformation

Name Path Type Description
status
 status string

The status.
transactions
 transactions array of object

The array of transactions.
items
 transactions object

ResponseSuccessCreateNewEditorSession

Name Path Type Description
status
 status string

The status.
url
 url string

The URL.

ResponseUpdateTemplate

Name Path Type Description
status
 status string

The status.