PHPackages                             dynamicpdf/api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. dynamicpdf/api

ActiveLibrary[API Development](/categories/api)

dynamicpdf/api
==============

PHP client library for the DynamicPDF API.

v3.0.0(3mo ago)12.2k↓26.7%1MITPHPPHP &gt;=7.4

Since Sep 23Pushed 3mo ago1 watchersCompare

[ Source](https://github.com/dynamicpdf-api/php-client)[ Packagist](https://packagist.org/packages/dynamicpdf/api)[ Docs](https://dpdf.io/)[ RSS](/packages/dynamicpdf-api/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (1)Versions (24)Used By (0)

[![](./logo-banner2.png)](./logo-banner2.png)

PHP Client (`php-client`)
=========================

[](#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-security-info`
- `pdf-text`
- `pdf-xmp`

For more information, please visit [DynamicPDF API](https://dpdf.io/ "DynamicPDF API Homepage"). Support for other languages/platforms (PHP, C#, Node.js) is available on GitHub ([DynamicPDF API at GitHub](https://github.com/dynamicpdf-api "DynamicPDF API at GitHub")).

Requirements
------------

[](#requirements)

- [PHP 7.4.0 or higher](https://www.php.net/)

Installation
------------

[](#installation)

Use Composer to install the client library. You can also download a zip file that you can use to install the client library manually.

### Composer

[](#composer)

The preferred method is via [Composer](https://getcomposer.org/). Install Composer as follows.

- Install Composer if not already installed ([installation instructions](https://getcomposer.org/doc/00-intro.md)).
- Ensure the `ext_curl` extension is enabled in your `php.ini` file ([installation instructions](https://www.php.net/manual/en/install.pecl.php)).
- Execute the following command in your project root folder.

```
composer update

```

### Manual Installation

[](#manual-installation)

To manually install the client library, download the zip file from [Github](https://codeload.github.com/dynamicpdf-api/php-client/zip/refs/heads/main). Unzip the php-client-library on your local machine and then use the library in you local code by requiring the following file.

```
require_once '/src/DpdfAPI.php'
```

A sample file, `PdfExample.php` is included in the zip file demonstrating its use.

Documentation
-------------

[](#documentation)

- Obtain overview documentation for the DynamicPDF API Client libraries from the [API Users Guide](https://dpdf.io/docs/usersguide/cloud-api/client-libraries/cloud-api-client-libraries).
- Access the documentation for each particular endpoint from the following Users Guide pages.

EndpointREST EndpointREST Endpoint Client LibraryDescription`dlex-layout`[API Users Guide - `dlex-layout`](https://dpdf.io/docs/usersguide/cloud-api/cloud-api-dlex-layout)[`dlex-layout`](https://dpdf.io/docs/usersguide/cloud-api/client-libraries/client-api-dlex-layout)Returns a PDF after processing a DLEX file with it's associated JSON data.`image-info`[API Users Guide - `image-info`](https://dpdf.io/docs/usersguide/cloud-api/cloud-api-image-info)[`image-info`](https://dpdf.io/docs/usersguide/cloud-api/client-libraries/client-api-image-info)Returns image metadata as a JSON document.`pdf`[API Users Guide - `pdf`](https://dpdf.io/docs/usersguide/cloud-api/cloud-api-pdf)[`pdf`](https://dpdf.io/docs/usersguide/cloud-api/client-libraries/client-api-pdf)Returns a PDF after performing one of the pdf endpoint's tasks (`page`, `dlex`, `image`) or merging.`pdf-security-info`[API Users Guide - `pdf-security-info`](https://dpdf.io/docs/usersguide/cloud-api/cloud-api-pdf-security-info)[`pdf-security-info`](https://dpdf.io/docs/usersguide/cloud-api/client-libraries/cloud-api-pdf-security-info)Returns PDFs Security metadata as a JSON document.`pdf-info`[API Users Guide - `pdf-Info`](https://dpdf.io/docs/usersguide/cloud-api/cloud-api-pdf-info)[`pdf-info`](https://dpdf.io/docs/usersguide/cloud-api/client-libraries/client-api-pdf-info)Returns PDF metadata as a JSON document.`pdf-text`[API Users Guide - `pdf-text`](https://dpdf.io/docs/usersguide/cloud-api/cloud-api-pdf-text)[`pdf-text`](https://dpdf.io/docs/usersguide/cloud-api/client-libraries/client-api-pdf-text)Returns the text from a PDF as a JSON document.`pdf-xmp`[API Users Guide - `pdf-xmp`](https://dpdf.io/docs/usersguide/cloud-api/cloud-api-pdf-xmp)[`pdf-xmp`](https://dpdf.io/docs/usersguide/cloud-api/client-libraries/client-api-pdf-xmp)Returns XMP metadata from a PDF.REST Client
-----------

[](#rest-client)

- The `php-client` uses the PHP built-in [cURL](https://curl.se/) application. Refer to the [Client URL Library](https://www.php.net/manual/en/book.curl.php) page in the PHP Manual for more information.

**Tutorials**
-------------

[](#tutorials)

The following table lists the available tutorials.

Tutorial TitleTutorial LocationMerging PDFsCompleting an AcroFormCreating a PDF Using a DLEX and the `pdf` EndpointAdding Bookmarks to a PDFCreating a PDF Using the `dlex-layout` EndpointExtracting Image MetadataExtract PDF MetadataExtracting PDF's TextExtract XMP MetadataFor more information on the tutorials and example code, refer to

- , and
- .

Support
=======

[](#support)

The primary source for the DynamicPDF API support is through [Stack Overflow](https://stackoverflow.com/questions/tagged/dynamicpdf-api). Please use the "[dynamicpdf-api](https://stackoverflow.com/questions/tagged/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 .

Pro Plan Subscribers[\#](https://dpdf.io/support#pro-plan-subscribers)
----------------------------------------------------------------------

[](#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  if you need to ask something specific to your use case that may not help the DynamicPDF API community.

License
=======

[](#license)

The `php-client` library is licensed under the [MIT License](./LICENSE).

###  Health Score

47

—

FairBetter than 94% of packages

Maintenance81

Actively maintained with recent releases

Popularity21

Limited adoption so far

Community15

Small or concentrated contributor base

Maturity60

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~72 days

Recently: every ~86 days

Total

23

Last Release

99d ago

Major Versions

v0.9.3-beta3 → v1.0.02021-11-29

v1.4.0 → v2.0.02024-02-12

v2.5.0 → v3.0.02026-02-09

PHP version history (3 changes)v0.9.1-betaPHP &gt;=7.3, &lt;=8.0

v0.9.2-beta2PHP &gt;=7.3

v2.5.0PHP &gt;=7.4

### Community

Maintainers

![](https://www.gravatar.com/avatar/0733754fd10b4efc39abdccb7d4d33f49041a41abd2cced7fd1ece5262afbcb7?d=identicon)[cetesoftwaredevteam](/maintainers/cetesoftwaredevteam)

---

Top Contributors

[![Jayasankar2424](https://avatars.githubusercontent.com/u/257710372?v=4)](https://github.com/Jayasankar2424 "Jayasankar2424 (43 commits)")[![bp-arun](https://avatars.githubusercontent.com/u/96294257?v=4)](https://github.com/bp-arun "bp-arun (24 commits)")[![RamyashreeNG](https://avatars.githubusercontent.com/u/71891168?v=4)](https://github.com/RamyashreeNG "RamyashreeNG (11 commits)")[![raghuwanshi](https://avatars.githubusercontent.com/u/11830165?v=4)](https://github.com/raghuwanshi "raghuwanshi (8 commits)")[![jamesabrannan](https://avatars.githubusercontent.com/u/1355741?v=4)](https://github.com/jamesabrannan "jamesabrannan (6 commits)")[![andrewcochran](https://avatars.githubusercontent.com/u/70348829?v=4)](https://github.com/andrewcochran "andrewcochran (3 commits)")[![gshubli](https://avatars.githubusercontent.com/u/257711887?v=4)](https://github.com/gshubli "gshubli (2 commits)")

---

Tags

apipdfencryptreportmergecreateform fill

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/dynamicpdf-api/health.svg)

```
[![Health](https://phpackages.com/badges/dynamicpdf-api/health.svg)](https://phpackages.com/packages/dynamicpdf-api)
```

###  Alternatives

[allure-framework/allure-php-api

Allure PHP commons

3411.1M7](/packages/allure-framework-allure-php-api)[pdfcrowd/pdfcrowd

A client library for the Pdfcrowd API. It lets you convert between HTML, PDF and various image formats

631.1M1](/packages/pdfcrowd-pdfcrowd)[aspose-cloud/aspose-words-cloud

Open, generate, edit, split, merge, compare and convert Word documents. Integrate Cloud API into your solutions to manipulate documents. Convert PDF to Word (DOC, DOCX, ODT, RTF and HTML) and in the opposite direction.

32157.4k](/packages/aspose-cloud-aspose-words-cloud)[ezsystems/allure-php-api

PHP API for Allure adapter

13431.1k11](/packages/ezsystems-allure-php-api)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
