PHP Client (php-client)

The PHP Client (php-client) project uses the DynamicPDF API's PHP client library to create, merge, split, form fill, stamp, obtain metadata, convert, and secure/encrypt PDF documents.

The DynamicPDF API consists of the following endpoints.

• dlex-layout
• image-info
• pdf
• pdf-info
• pdf-text
• pdf-xmp

For more information, please visit DynamicPDF API. Support for other languages/platforms (PHP, C#, Node.js) is available on GitHub (DynamicPDF API at GitHub).

Requirements

• PHP 7.3.0 or higher

Installation

Use Composer to install the client library.

Composer

The preferred method is via Composer. Install Composer as follows.

• Install Composer if not already installed (installation instructions).

• Ensure the ext_curl extension is enabled in your php.ini file (installation instructions).

• Execute the following command in your project root folder.

composer update

Documentation

• Obtain overview documentation for the DynamicPDF API Client libraries from the API Users Guide.
• Access the documentation for each particular endpoint from the following Users Guide pages.

Endpoint	REST Endpoint	REST Endpoint Client Library	Description
dlex-layout	API Users Guide - dlex-layout	dlex-layout	Returns a PDF after processing a DLEX file with it's associated JSON data.
image-info	API Users Guide - image-info	image-info	Returns image metadata as a JSON document.
pdf	API Users Guide - pdf	pdf	Returns a PDF after performing one of the pdf endpoint's tasks (page, dlex, image) or merging.
pdf-info	API Users Guide - pdf-Info	pdf-info	Returns PDF metadata as a JSON document.
pdf-text	API Users Guide - pdf-text	pdf-text	Returns the text from a PDF as a JSON document.
pdf-xmp	API Users Guide - pdf-xmp	pdf-xmp	Returns XMP metadata from a PDF.

REST Client

• The php-client uses the PHP built-in cURL application. Refer to the Client URL Library page in the PHP Manual for more information.

Tutorials

The following table lists the available tutorials.

Tutorial Title	Tutorial Location
Merging PDFs	https://dpdf.io/docs/tutorials/cloud-api/merging-pdfs
Completing an AcroForm	https://dpdf.io/docs/tutorials/cloud-api/form-completion
Creating a PDF Using a DLEX and the pdf Endpoint	https://dpdf.io/docs/tutorials/cloud-api/dlex-pdf-endpoint
Adding Bookmarks to a PDF	https://dpdf.io/docs/tutorials/cloud-api/bookmarks
Creating a PDF Using the dlex-layout Endpoint	https://dpdf.io/docs/tutorials/cloud-api/dlex-layout
Extracting Image Metadata	https://dpdf.io/docs/tutorials/cloud-api/image-info
Extract PDF Metadata	https://dpdf.io/docs/tutorials/cloud-api/pdf-info
Extracting PDF's Text	https://dpdf.io/docs/tutorials/cloud-api/pdf-text
Extract XMP Metadata	https://dpdf.io/docs/tutorials/cloud-api/pdf-xmp

For more information on the tutorials and example code, refer to

• https://dpdf.io/docs/tutorials/tutorials-overview, and
• https://dpdf.io/docs/usersguide/cloud-api/cloud-api-overview.

Support

The primary source for the DynamicPDF API support is through Stack Overflow. Please use the "dynamicpdf-api" tag to ask questions. Our support team actively monitors the tag and responds promptly to any questions. Also, let us know you asked the question by following up with an email to [email protected].

Pro Plan Subscribers#

Ticket support is available to Pro Plan subscribers. But we still encourage you to help the community by posting on Stack Overflow when possible. You can also email [email protected] if you need to ask something specific to your use case that may not help the DynamicPDF API community.

License

The php-client library is licensed under the MIT License.