dynamicpdf/api
Composer 安装命令:
composer require dynamicpdf/api
包简介
PHP client library for the DynamicPDF API.
README 文档
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-layoutimage-infopdfpdf-infopdf-security-infopdf-textpdf-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. You can also download a zip file that you can use to install the client library manually.
Composer
The preferred method is via Composer. Install Composer as follows.
-
Install Composer if not already installed (installation instructions).
-
Ensure the
ext_curlextension is enabled in yourphp.inifile (installation instructions). -
Execute the following command in your project root folder.
composer update
Manual Installation
To manually install the client library, download the zip file from Github. 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 '<path-to-client-library>/src/DpdfAPI.php'
A sample file, PdfExample.php is included in the zip file demonstrating its use.
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-security-info |
API Users Guide - pdf-security-info |
pdf-security-info |
Returns PDFs Security metadata as a JSON document. |
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-clientuses 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 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.
dynamicpdf/api 适用场景与选型建议
dynamicpdf/api 是一款 基于 PHP 开发的 Composer 扩展包,目前已累计 2.38k 次下载、GitHub Stars 达 1, 最近一次更新时间为 2021 年 09 月 23 日, 在 PHP 生态内属于活跃度较高的组件。
它主要适用于以下技术方向: 「api」 「pdf」 「report」 「merge」 「encrypt」 「create」 等业务场景。在实际项目中,围绕这些方向常见需要落地的问题包括:接口对接、性能调优、并发安全、与既有框架(Laravel / ThinkPHP / Yii / Webman 等)的兼容适配,以及生产环境的日志埋点与稳定性保障。
我们在过去多个企业项目中使用过 dynamicpdf/api 或与其功能相近的方案,如果你在选型或落地过程中遇到问题,例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查,欢迎联系我们协助评估。
基于 dynamicpdf/api 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。
线上偶发问题、内存泄漏、慢查询、并发异常等排查修复;针对高流量场景做缓存、队列、索引层面的调优。
承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维;也可按月提供技术保姆服务。
与 dynamicpdf/api 相关的其它包
同方向 / 同关键字的高下载量 PHP Composer 包推荐,方便对比选型:
Reportico Open Source PHP Report Designer
A PSR-7 compatible library for making CRUD API endpoints
Allow KoolReport to use twig template engine to render view
Pure PHP library to read JRXML files made with 'JasperSoft Studio' and generate reports in PDF
Sistema AMOS per le segnalazioni
Provides TCPDF integration for Symfony
统计信息
- 总下载量: 2.38k
- 月度下载量: 0
- 日度下载量: 0
- 收藏数: 1
- 点击次数: 15
- 依赖项目数: 0
- 推荐数: 0
其他信息
- 授权协议: MIT
- 更新时间: 2021-09-23
