PHPackages                             compdfkit/compdfkit-api-php - 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. compdfkit/compdfkit-api-php

ActiveLibrary[API Development](/categories/api)

compdfkit/compdfkit-api-php
===========================

ComPDFKit API PHP SDK

v1.3.2(2y ago)217901MITPHPPHP >=7.0

Since Aug 14Pushed 2y agoCompare

[ Source](https://github.com/ComPDFKit/compdfkit-api-php)[ Packagist](https://packagist.org/packages/compdfkit/compdfkit-api-php)[ Docs](https://api.compdf.com/api-reference/overview)[ RSS](/packages/compdfkit-compdfkit-api-php/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (2)Versions (3)Used By (0)

ComPDFKit API in PHP
====================

[](#compdfkit-api-in-php)

Introduction
------------

[](#introduction)

[ComPDFKit](https://www.compdf.com/) offers powerful and steady PDF libraries and complete PDF functions to build PDF viewer and editor, which allows to preview, edit, annotate, sign, encrypt and decrypt PDF files.

[ComPDFKit API](https://api.compdf.com/api-reference/overview) provides a variety of PHP API tools that allow you to create an efficient document processing workflow in a single API call.

ComPDFKit API allows you to get 1000 files processing monthly now! Just [sign up](https://api.compdf.com/signup) for a free trial and enjoy comprehensive PDF functions.

### Related

[](#related)

- ComPDFKit API - Java Library: [ComPDFKit API - Java Library](https://github.com/ComPDFKit/compdfkit-api-java)
- ComPDFKit API - Swift Library: [ComPDFKit API - Swift Library](https://github.com/ComPDFKit/compdfkit-api-swift)
- ComPDFKit API - Python Library: [ComPDFKit API - Python Library](https://github.com/ComPDFKit/compdfkit-api-python)
- ComPDFKit API - C#.NET Library: [ComPDFKit API - C#.NET Library](https://github.com/ComPDFKit/compdfkit-api-.net)

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

[](#requirements)

Programming Environment: PHP Version 7.0 and higher.

Dependencies: Composer.

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

[](#installation)

You can install the library via Composer. Run the following command.

```
composer require compdfkit/compdfkit-api-php
```

Alternatively, you can add "compdfkit/compdfkit-api-php": "^1.2.4" to your ***"composer.json"*** file and then run it.

```
composer update
```

If you are not using a PHP framework with autoload feature, you need to use the code below to autoload.

```
require_once('vendor/autoload.php');
```

Usage
-----

[](#usage)

### Create An API Client

[](#create-an-api-client)

First of all, please create an API client to complete the authentication. You need to [sign in](https://api.compdf.com/login) your ComPDFKit API account to get your **publicKey** and **secretKey** at the [dashboard](https://api-dashboard.compdf.com/api/keys). If you are new to ComPDFKit, click here to [sign up](https://api.compdf.com/signup) for a free trial to process 1,000 documents per month for free.

- Project public Key: You can find the public key in the **API Keys** section of your ComPDFKit API account.
- Project secret Key: You can find the secret Key in the **API Keys** section of your ComPDFKit API account.

```
$client = new CPDFClient('public_key', 'secret_key');
```

### Create A Task

[](#create-a-task)

A task ID is automatically generated for you based on the type of PDF tool you choose. You can provide the callback notification URL. After the task processing is completed, we will notify you of the task result through the callback interface. You can perform other operations according to the request result, such as checking the status of the task, uploading files, starting the task, or downloading the result file.

```
// Create a client
$client = new CPDFClient('public_key', 'secret_key');

// Create a task
// Create an example of a PDF TO WORD task
$taskInfo = $client->createTask(CPDFConversion::PDF_TO_WORD);
```

### Upload Files

[](#upload-files)

Upload the original file and bind the file to the task ID. The field parameter is used to pass the JSON string to set the processing parameters for the file. Each file will generate automatically a unique filekey. Please note that a maximum of five files can be uploaded for a task ID and no files can be uploaded for that task after it has started.

```
// Create a client
$client = new CPDFClient('public_key', 'secret_key');

// Create a task
// Create an example of a PDF TO WORD task
$taskInfo = $client->createTask(CPDFConversion::PDF_TO_WORD);

// Upload files
$file = $client->addFile('test.pdf')->uploadFile($taskInfo['taskId']);
```

### Execute the Task

[](#execute-the-task)

After the file upload is completed, call this interface with the task ID to process the files.

```
// Create a client
$client = new CPDFClient('public_key', 'secret_key');

// Create a task
// Create an example of a PDF TO WORD task
$taskInfo = $client->createTask(CPDFConversion::PDF_TO_WORD);

// Upload files
$file = $client->addFile('test.pdf')->uploadFile($taskInfo['taskId']);

// execute Task
$client->executeTask($taskInfo['taskId']);
```

### Get The Task Info

[](#get-the-task-info)

Request task status and file-related meta data based on the task ID.

```
// Create a client
$client = new CPDFClient('public_key', 'secret_key');

// Create a task
// Create an example of a PDF TO WORD task
$taskInfo = $client->createTask(CPDFConversion::PDF_TO_WORD);

// Upload files
$file = $client->addFile('test.pdf')->uploadFile($taskInfo['taskId']);

// Execute Task
$client->executeTask($taskInfo['taskId']);

// Query TaskInfo
$taskInfo = $client->getTaskInfo($taskInfo['taskId']);
```

Examples
--------

[](#examples)

There are many examples in the **samples** folder, which show the main features of the ComPDFKit API and how to use them, such as watermarking PDFs, converting PDF to Word, Excel, JPG, PNG, etc. You can copy the code to your project and run it directly. To learn more about the ComPDFKit API, please visit our [API Reference](https://api.compdf.com/api-reference/overview).

Free Trial
----------

[](#free-trial)

[ComPDFKit API](https://api.compdf.com/) is a powerful API that can be used to create an efficient document processing workflow in a single API call.

If you do not have a ComPDFKit API account, you can [sign up for a free trial](https://api.compdf.com/signup) to process 1,000 documents per month for free.

Once you have a ComPDFKit API account, you can obtain your **publicKey** and **secretKey** in the [dashboard](https://api-dashboard.compdf.com/api/keys).

Support
-------

[](#support)

[ComPDFKit](https://www.compdf.com/) has a professional R&D team that produces comprehensive technical documentation and guides to help developers. Also, you can get an immediate response when reporting your problems to our support team.

For detailed information, please visit our [Guides page](https://api.compdf.com/api/docs/guides).

Stay updated with the latest improvements through our [Changelog](https://www.compdf.com/api/changelog-compdfkit-api).

For technical assistance, please reach out to our [Technical Support](https://www.compdf.com/support).

To get more details and an accurate quote, please contact our [Sales Team](https://www.compdf.com/contact-sales).

License
-------

[](#license)

- The code is available as open source under the terms of the [Apache-2.0 License](https://opensource.org/license/apache-2-0).

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity24

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity40

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

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 ~24 days

Total

2

Last Release

985d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/0c44de984f9a02f73e23eea9d37499f0e4aef9b8e54448d55d3a122592ffac86?d=identicon)[youna12345](/maintainers/youna12345)

---

Top Contributors

[![youna12345](https://avatars.githubusercontent.com/u/108785628?v=4)](https://github.com/youna12345 "youna12345 (3 commits)")

---

Tags

apicompdfkit-apipdfpdf-converterpdf-documentpdf-editorpdf-viewerphp

### Embed Badge

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

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

###  Alternatives

[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[convertkit/convertkitapi

Kit PHP SDK for the Kit API

2167.1k1](/packages/convertkit-convertkitapi)[mapado/rest-client-sdk

Rest Client SDK for hydra API

1125.9k2](/packages/mapado-rest-client-sdk)

PHPackages © 2026

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