Issuu API for PHP客户端

v3.0.1 2024-05-14 14:40 UTC

This package is auto-updated.

Last update: 2024-09-14 15:42:35 UTC


README

Latest Version Latest build

Issuu - PHP API客户端

备注

版本3.0是为Issuu API v2设计的。旧API已于2024年5月1日弃用。

安装

您可以使用以下命令通过composer安装此包:

composer require lasselehtinen/issuu

支持的功能

草稿

出版物

堆栈

统计数据

用户

使用方法

创建客户端

首先使用您的API密钥和密钥创建一个新的实例

use lasselehtinen\Issuu\Issuu;

$issuu = new Issuu('apiKey');
$drafts = new Drafts($issuu);

$body = [
    'confirmCopyright' => true,
    'fileUrl' => 'https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf',
    'info' => [
        'file' => 0,
        'access' => 'PUBLIC',
        'title' => 'Example title',
        'description' => 'Description',
        'preview' => false,
        'type' => 'editorial',
        'showDetectedLinks' => false,
        'downloadable' => false,
        'originalPublishDate' => '1970-01-01T00:00:00.000Z',
    ],
];

$createDraft = $drafts->create($body);

// Try few times until the file is converted
for ($i=0; $i < 10; $i++) {
    $draft = $drafts->getDraftBySlug($createDraft->slug);
    
    if ($draft->fileInfo->conversionStatus === 'DONE') {
        break;
    }

    sleep(2);
}

$publishDraftBySlug = $drafts->publishDraftBySlug($createDraft->slug, ['desiredName' => 'foobar']);

贡献

欢迎提交拉取请求。

拉取请求

  • 使用 PSR-2编码标准.
  • 添加测试! 如果您的补丁没有测试,则不会被接受。
  • 记录任何行为变化。 确保保持README.md和任何其他相关文档的最新状态。
  • 发送连贯的历史记录。 确保您的拉取请求中的每个单独提交都具有重要意义。如果您在开发过程中不得不进行多次中间提交,请在提交之前压缩它们

运行测试

$ phpunit

问题

如果您有问题或建议,请在GitHub上创建新问题

许可

MIT许可(MIT)。有关更多信息,请参阅许可文件