dynamicpdf / api
PHP client library for the DynamicPDF API.
Requires
- php: >=7.3
- ext-curl: *
- ext-fileinfo: *
Requires (Dev)
- phpunit/phpunit: ^9
README
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
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 yourphp.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.
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.
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 support@dynamicpdf.com.
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 support@dynamicpdf.com 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.