JSON API - mergePdf

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

mergePdf

PREMIUM

TRIAL / ADVANCED

Merges PDF documents.

Note

You are reading the JSON API documentation. For the PHP API method please go to mergePdf.

JSON data

{
    "documents": array,
    "options": {
        "annotations": boolean,
        "addPageNumbers": boolean,
        "pageNumbersOptions": {
            "bold": boolean,
            "color": array,
            "excludeFirstPage": boolean,
            "font": string,
            "fontSize": number,
            "format": string,
            "italic": boolean,
            "position": array,
            "startNumber": number,
            "underline": boolean
        },
        "useFixedAnnotationPositions": boolean
    }
}

Key	Description
documents	Array of PDF documents to merge. Each item can be a path to a local document, a Base64 string, or a stream.
annotations	Import annotations (links, comments and others). Default as false.
addPageNumbers	Add page numbers. Default as false.
pageNumbersOptions	Use with addPageNumbers. bold: default as false color: default as array(255, 255, 255) excludeFirstPage: default as false font: default as 'Helvetica' fontSize: default as 7 format: default as 'Page INDEXPAGE of TOTALPAGES' italic: default as false position: position. Default as array(0, 0) => (x, y) startNumber: default as 1 underline: default as false
useFixedAnnotationPositions	Force annotation page link IDs. Useful when using PDF readers that don't detect all PDF contents automatically. Default as false.

Code samples

Example #1

{
    "actions": [
        {
            "action": "mergePdf",
            "data": {
                "documents": [
                    "document_1.pdf",
                    "document_2.pdf",
                    "document_3.pdf"
                ]
            }
        }
    ]
}

A document can be a local file, a Base64 string, or a remote file.

Release notes

phpdocx 18.0:
- new action.