Muhimbi PDF (Preview)

Muhimbi PDF (Preview)

Convert, Merge, Watermark, Secure and OCR files.

Actions

Add PDF watermark

Add a PDF based watermark to a PDF file.

Required Parameters

Source file content
byte
Content of the file to watermark
PDF Watermark
byte
PDF watermark content or URL
Position
enum
Watermark position on the page
Width
string
Width of the watermark (in Pts, 1/72 of an inch)
Height
string
Height of the watermark (in Pts, 1/72 of an inch)

Optional Parameters

Source file name
string
Optional file name (for logging purposes)
X Coordinate (When 'Position' is set to 'Absolute')
string
X Coordinate of the watermark (in Pts, 1/72 of an inch)
Y Coordinate (When 'Position' is set to 'Absolute')
string
Y Coordinate of the watermark (in Pts, 1/72 of an inch)
Layer
enum
Watermark layer
Rotation
string
Angle of rotation
Opacity
string
Opacity in % (100 is fully visible and 1 is barely visible)
Watermark start page
integer
Number of the first page the watermark applies to
Watermark end page
integer
Number of the last page the watermark applies to
Watermark page interval
integer
Which pages to display the watermark on (1=every page, 2=every other, etc)
Watermark page orientation
enum
Orientation of pages the watermark applies to.
Fail on error
boolean
Fail on error

Returns

Body
operation_response

Response data for all operations

Add QR Code watermark

Add a QR Code watermark to a PDF file.

Required Parameters

Source file content
byte
Content of the file to watermark
Content
string
Data to embed in the QR Code
Version
enum
Version
Input mode
enum
Input mode
Error correction level
enum
Error correction level
Position
enum
Watermark position on the page
Width
string
Width of the watermark (in Pts, 1/72 of an inch)
Height
string
Height of the watermark (in Pts, 1/72 of an inch)

Optional Parameters

Source file name
string
Optional file name (for logging purposes)
X Coordinate (When 'Position' is set to 'Absolute')
string
X Coordinate of the watermark (in Pts, 1/72 of an inch)
Y Coordinate (When 'Position' is set to 'Absolute')
string
Y Coordinate of the watermark (in Pts, 1/72 of an inch)
Layer
enum
Watermark layer
Rotation
string
Angle of rotation
Opacity
string
Opacity in % (100 is fully visible and 1 is barely visible)
Watermark background color
string
Color in #RRGGBB notation
Watermark foreground color
string
Color in #RRGGBB notation
Watermark start page
integer
Number of the first page the watermark applies to
Watermark end page
integer
Number of the last page the watermark applies to
Watermark page interval
integer
Which pages to display the watermark on (1=every page, 2=every other, etc)
Watermark page orientation
enum
Orientation of pages the watermark applies to.
Fail on error
boolean
Fail on error

Returns

Body
operation_response

Response data for all operations

Add RTF watermark

Add a rich-text watermark to a PDF file.

Required Parameters

Source file content
byte
Content of the file to watermark
Watermark content
string
Watermark text in RTF format
Position
enum
Watermark position on the page
Width
string
Width of the watermark (in Pts, 1/72 of an inch)
Height
string
Height of the watermark (in Pts, 1/72 of an inch)

Optional Parameters

Source file name
string
Optional file name (for logging purposes)
X Coordinate (When 'Position' is set to 'Absolute')
string
X Coordinate of the watermark (in Pts, 1/72 of an inch)
Y Coordinate (When 'Position' is set to 'Absolute')
string
Y Coordinate of the watermark (in Pts, 1/72 of an inch)
Layer
enum
Watermark layer
Rotation
string
Angle of rotation
Opacity
string
Opacity in % (100 is fully visible and 1 is barely visible)
Watermark background color
string
Color in #RRGGBB notation
Watermark outline color
string
Color in #RRGGBB notation
Watermark outline width
string
Width of the watermark outline (in Pts, 1/72 of an inch)
Watermark start page
integer
Number of the first page the watermark applies to
Watermark end page
integer
Number of the last page the watermark applies to
Watermark page interval
integer
Which pages to display the watermark on (1=every page, 2=every other, etc)
Watermark page orientation
enum
Orientation of pages the watermark applies to.
Fail on error
boolean
Fail on error

Returns

Body
operation_response

Response data for all operations

Add composite watermark

Add a complex watermark to a PDF file.

Required Parameters

Source file content
byte
Content of the file to watermark
Watermark data
string
Watermark data in Muhimbi XML format

Optional Parameters

Source file name
string
Optional file name (for logging purposes)
Fail on error
boolean
Fail on error

Returns

Body
operation_response

Response data for all operations

Add ellipse watermark

Add an ellipse watermark to a PDF file.

Required Parameters

Source file content
byte
Content of the file to watermark
Position
enum
Watermark position on the page
Width
string
Width of the watermark (in Pts, 1/72 of an inch)
Height
string
Height of the watermark (in Pts, 1/72 of an inch)

Optional Parameters

Source file name
string
Optional file name (for logging purposes)
X Coordinate (When 'Position' is set to 'Absolute')
string
X Coordinate of the watermark (in Pts, 1/72 of an inch)
Y Coordinate (When 'Position' is set to 'Absolute')
string
Y Coordinate of the watermark (in Pts, 1/72 of an inch)
Layer
enum
Watermark layer
Rotation
string
Angle of rotation
Opacity
string
Opacity in % (100 is fully visible and 1 is barely visible)
Fill color
string
Color in #RRGGBB notation
Line color
string
Color in #RRGGBB notation
Line width
string
Width of the line (in Pts, 1/72 of an inch)
Watermark start page
integer
Number of the first page the watermark applies to
Watermark end page
integer
Number of the last page the watermark applies to
Watermark page interval
integer
Which pages to display the watermark on (1=every page, 2=every other, etc)
Watermark page orientation
enum
Orientation of pages the watermark applies to.
Fail on error
boolean
Fail on error

Returns

Body
operation_response

Response data for all operations

Add image watermark

Add an image based watermark to a PDF file.

Required Parameters

Source file content
byte
Content of the file to watermark
Image
byte
Image content or URL
Position
enum
Watermark position on the page
Width
string
Width of the watermark (in Pts, 1/72 of an inch)
Height
string
Height of the watermark (in Pts, 1/72 of an inch)

Optional Parameters

Source file name
string
Optional file name (for logging purposes)
X Coordinate (When 'Position' is set to 'Absolute')
string
X Coordinate of the watermark (in Pts, 1/72 of an inch)
Y Coordinate (When 'Position' is set to 'Absolute')
string
Y Coordinate of the watermark (in Pts, 1/72 of an inch)
Layer
enum
Watermark layer
Rotation
string
Angle of rotation
Opacity
string
Opacity in % (100 is fully visible and 1 is barely visible)
Watermark background color
string
Color in #RRGGBB notation
Watermark outline color
string
Color in #RRGGBB notation
Watermark outline width
string
Width of the watermark outline (in Pts, 1/72 of an inch)
Watermark start page
integer
Number of the first page the watermark applies to
Watermark end page
integer
Number of the last page the watermark applies to
Watermark page interval
integer
Which pages to display the watermark on (1=every page, 2=every other, etc)
Watermark page orientation
enum
Orientation of pages the watermark applies to.
Fail on error
boolean
Fail on error

Returns

Body
operation_response

Response data for all operations

Add line watermark

Add a line watermark to a PDF file.

Required Parameters

Source file content
byte
Content of the file to watermark
Position
enum
Watermark position on the page
X Coordinate (start)
string
Start X Coordinate of the line (in Pts, 1/72 of an inch)
Y Coordinate (start)
string
Start Y Coordinate of the line (in Pts, 1/72 of an inch)
X Coordinate (end)
string
End X Coordinate of the line (in Pts, 1/72 of an inch)
Y Coordinate (end)
string
End Y Coordinate of the line (in Pts, 1/72 of an inch)

Optional Parameters

Source file name
string
Optional file name (for logging purposes)
Layer
enum
Watermark layer
Rotation
string
Angle of rotation
Opacity
string
Opacity in % (100 is fully visible and 1 is barely visible)
Line color
string
Color in #RRGGBB notation
Line width
string
Width of the line (in Pts, 1/72 of an inch)
Watermark start page
integer
Number of the first page the watermark applies to
Watermark end page
integer
Number of the last page the watermark applies to
Watermark page interval
integer
Which pages to display the watermark on (1=every page, 2=every other, etc)
Watermark page orientation
enum
Orientation of pages the watermark applies to.
Fail on error
boolean
Fail on error

Returns

Body
operation_response

Response data for all operations

Add rectangle watermark

Add a rectangle watermark to a PDF file.

Required Parameters

Source file content
byte
Content of the file to watermark
Position
enum
Watermark position on the page
Width
string
Width of the watermark (in Pts, 1/72 of an inch)
Height
string
Height of the watermark (in Pts, 1/72 of an inch)

Optional Parameters

Source file name
string
Optional file name (for logging purposes)
X Coordinate (When 'Position' is set to 'Absolute')
string
X Coordinate of the watermark (in Pts, 1/72 of an inch)
Y Coordinate (When 'Position' is set to 'Absolute')
string
Y Coordinate of the watermark (in Pts, 1/72 of an inch)
Layer
enum
Watermark layer
Rotation
string
Angle of rotation
Opacity
string
Opacity in % (100 is fully visible and 1 is barely visible)
Watermark background color
string
Color in #RRGGBB notation
Watermark outline color
string
Color in #RRGGBB notation
Watermark outline width
string
Width of the watermark outline (in Pts, 1/72 of an inch)
Watermark start page
integer
Number of the first page the watermark applies to
Watermark end page
integer
Number of the last page the watermark applies to
Watermark page interval
integer
Which pages to display the watermark on (1=every page, 2=every other, etc)
Watermark page orientation
enum
Orientation of pages the watermark applies to.
Fail on error
boolean
Fail on error

Returns

Body
operation_response

Response data for all operations

Add text watermark

Add a plain-text watermark to a PDF file.

Required Parameters

Source file content
byte
Content of the file to watermark
Watermark content
string
Watermark text
Font family name
string
Name of the font, e.g. Arial, Times New Roman, Calibri
Font size
string
Size of the font in Pt
Font color
string
Color in #RRGGBB notation
Text alignment
enum
Text alignment
Word wrap
enum
Spcifies if wordwrap text
Position
enum
Watermark position on the page
Width
string
Width of the watermark (in Pts, 1/72 of an inch)
Height
string
Height of the watermark (in Pts, 1/72 of an inch)

Optional Parameters

Source file name
string
Optional file name (for logging purposes)
X Coordinate (When 'Position' is set to 'Absolute')
string
X Coordinate of the watermark (in Pts, 1/72 of an inch)
Y Coordinate (When 'Position' is set to 'Absolute')
string
Y Coordinate of the watermark (in Pts, 1/72 of an inch)
Layer
enum
Watermark layer
Rotation
string
Angle of rotation
Opacity
string
Opacity in % (100 is fully visible and 1 is barely visible)
Font style
string
One or more styles, e.g. bold|italic|underline|strikeout
Font outline color
string
Color in #RRGGBB notation
Font outline width
string
Width of the font outline (in Pts, 1/72 of an inch)
Watermark start page
integer
Number of the first page the watermark applies to
Watermark end page
integer
Number of the last page the watermark applies to
Watermark page interval
integer
Which pages to display the watermark on (1=every page, 2=every other, etc)
Watermark page orientation
enum
Orientation of pages the watermark applies to.
Fail on error
boolean
Fail on error

Returns

Body
operation_response

Response data for all operations

Convert HTML to PDF

Convert URLs or HTML to PDF.

Required Parameters

Source URL or HTML
string
HTML fragment or URL to convert

Optional Parameters

Page orientation
enum
Page orientation
User name
string
User name
Password
password
Password
Authentication type
enum
Authentication type
Fail on error
boolean
Fail on error

Returns

Body
operation_response

Response data for all operations

Convert document

Convert a file to PDF or other format.

Required Parameters

Source file name
string
Name of the source file including extension
Source file content
byte
Content of the file to convert
Output format
enum
Output format

Optional Parameters

Override settings
string
Optional settings using Muhimbi's XML syntax
Template file content
byte
Optional template file content (e.g. infopath XSN file)
Fail on error
boolean
Fail on error

Returns

Body
operation_response

Response data for all operations

Convert to OCRed PDF

Convert a file to an OCRed PDF.

Required Parameters

Source file name
string
Name of the source file including extension
Source file content
byte
Content of the file to OCR

Optional Parameters

Language
enum
Language
Performance
enum
Performance
Blacklist / whitelist
enum
Characters option
Characters
string
Characters to blacklist or whitelist
Use pagination
boolean
Paginate
Regions
string
Limit the area to OCR to one or more specific areas
Fail on error
boolean
Fail on error

Returns

Body
operation_response

Response data for all operations

Copy metadata (SharePoint only)

Copy metadata and set content type.

Required Parameters

Site url
string
SharePoint site url (example: http://contoso.sharepoint.com/sites/mysite)
Source file url
string
Path to the source file
Destination file path
string
Path to the destination file

Optional Parameters

User name
string
User name to log in to the SharePoint site
Password
string
Password to log in to the SharePoint site
Fields to copy
string
Optional comma separated list of fields
Destination content type
string
Optional content type for the destination file
Fail on error
boolean
Fail on error

Returns

Body
operation_response_common

Response data for all operations

Extract text using OCR

Extract text from a file using OCR.

Required Parameters

Source file name
string
Name of the source file including extension
Source file content
byte
Content of the file to OCR

Optional Parameters

Language
enum
Languate
X Coordinate
string
X Coordinate (in Pts, 1/72 of an inch)
Y Coordinate
string
Y Coordinate (in Pts, 1/72 of an inch)
Width
string
Width of the OCR area (in Pts, 1/72 of an inch)
Height
string
Height of the OCR area (in Pts, 1/72 of an inch)
Page number
string
Page number (leave blank to OCR all pages)
Performance
enum
Performance ()
Blacklist / whitelist
enum
Characters option
Characters
string
Characters to blacklist or whitelist
Use pagination
boolean
Paginate
Fail on error
boolean
Fail on error

Returns

Body
ocr_operation_response

Response data for OCRText operation

Merge documents

Merge multiple files into a single PDF.

Required Parameters

Source file name - 1
string
Name of the source file including extension
Source file content - 1
byte
Content of the file to merge
Source file name - 2
string
Name of the source file including extension
Source file content - 2
byte
Content of the file to merge

Optional Parameters

Source file name - 3
string
Name of the source file including extension
Source file content - 3
byte
Content of the file to merge
Source file name - 4
string
Name of the source file including extension
Source file content - 4
byte
Content of the file to merge
Source file name - 5
string
Name of the source file including extension
Source file content - 5
byte
Content of the file to merge
Each document
enum
Document start page
Fail on error
boolean
Fail on error

Returns

Body
operation_response

Response data for all operations

Secure PDF

Apply security and encryption settings.

Required Parameters

Source file content
byte
Content of the file to secure

Optional Parameters

Source file name
string
Optional file name (for logging purposes)
Open password
password
Password required to open the PDF
Owner password
password
Password for PDF restrictions defined below
PDF restrictions
string
Print|HighResolutionPrint|ContentCopy|Annotations|FormFields|ContentAccessibility|DocumentAssembly
Fail on error
boolean
Fail on error

Returns

Body
operation_response

Response data for all operations

Split PDF

Split a PDF file into multiple PDFs.

Required Parameters

Source file name
string
Name of the source file including extension
Source file content
byte
Content of the file to split
Split by
enum
Split by option
Split parameter
integer
Split parameter (number of pages or level)

Optional Parameters

File name template
string
File name template for returned files
Fail on error
boolean
Fail on error

Returns

Body
split_operation_response

Response data for split operation

Definitions

ocr_operation_response

Response data for OCRText operation

Base file name
string
Name of the input file without the extension.
Out text
string
Extracted OCRed text in plain text.
Result code
enum
Operation result code.
Result details
string
Operation result details.

operation_response

Response data for all operations

Base file name
string
Name of the input file without the extension.
Processed file content
byte
File generated by the Muhimbi converter.
Result code
enum
Operation result code.
Result details
string
Operation result details.

operation_response_common

Response data for all operations

Base file name
string
Name of the input file without the extension.
Result code
enum
Operation result code.
Result details
string
Operation result details.

processed_files

Individual files

Processed file content
byte
File generated by the Muhimbi converter.
Processed file name
string
Name of the file with the extension.

split_operation_response

Response data for split operation

Processed files
array of processed_files
Files generated by the Muhimbi converter.
Result code
enum
Operation result code.
Result details
string
Operation result details.

Limits

NameCallsRenewal Period
API calls per connection10060 seconds

Using this Connector