README

使用我们的在线文件转换 API 转换您的文件

ConvertAPI 帮助转换各种文件格式。从 Word、Excel、Powerpoint、图片、网页或原始 HTML 代码等不同来源创建 PDF 和图片。合并、加密、拆分、修复和解密 PDF 文件，以及许多其他文件操作。您只需几分钟即可将其集成到应用程序中并轻松使用。

要求

PHP 8.1.0 及更高版本。

安装

首选方法是使用 composer。如果您尚未安装 composer，请遵循安装说明。

安装 composer 后，在项目根目录中执行以下命令以安装此库

composer require convertapi/convertapi-php

手动安装

如果您不希望使用 Composer，则必须要求 ConvertApi 自动加载器

require_once('/path/to/convertapi-php/lib/ConvertApi/autoload.php');

依赖项

库需要以下扩展才能正常工作

如果您使用 Composer，这些依赖项应自动处理。如果您手动安装，请确保这些扩展可用。

使用方法

配置

您可以在 https://www.convertapi.com/a 获取您的 API 凭证

use \ConvertApi\ConvertApi;

ConvertApi::setApiCredentials('your-api-secret-or-token');

文件转换

转换文件到 PDF 的示例。所有支持的格式和选项都可以在此处找到。

$result = ConvertApi::convert('pdf', ['File' => '/path/to/my_file.docx']);

# save to file
$result->getFile()->save('/path/to/save/file.pdf');

# get file contents (without saving the file locally)
$contents = $result->getFile()->getContents();

其他结果操作

# save all result files to folder
$result->saveFiles('/path/to/save/files');

# get conversion cost
$cost = $result->getConversionCost();

转换文件 URL

$result = ConvertApi::convert('pdf', ['File' => 'https://website/my_file.docx']);

指定格式

$result = ConvertApi::convert(
    'pdf',
    ['File' => '/path/to/my_file'],
    'docx'
);

附加转换参数

ConvertAPI 根据所选格式接受附加转换参数。所有转换参数和说明都可以在此处找到。

$result = ConvertApi::convert(
    'pdf',
    [
        'File' => '/path/to/my_file.docx',
        'PageRange' => '1-10',
        'PdfResolution' => '150',
    ]
);

用户信息

您可以通过获取用户信息来始终检查您的使用情况。

$info = ConvertApi::getUser();

echo $info['ConversionsConsumed'];

备用域名

使用 setApiBase 方法设置备用服务域名。适用于以下区域的专用域名列表域列表。

ConvertApi::setApiBase('https://eu-v2.convertapi.com/');

开发

使用 PHPUnit 进行测试

CONVERT_API_SECRET=your-api-secret ./bin/phpunit

贡献

欢迎在 GitHub 上提交有关错误的报告和拉取请求 https://github.com/ConvertAPI/convertapi-php。本项目旨在成为一个安全、欢迎的协作空间，并期望贡献者遵守贡献者公约行为准则。

许可

ConvertAPI PHP 客户端可在 MIT 许可证的条款下作为开源软件使用 https://open-source.org.cn/licenses/MIT。

convertapi / convertapi-php

维护者

详情