README

这是Clicksign REST API的PHP包装器。

如何使用

使用composer安装

创建一个名为 composer.json 的文件，内容如下

{
    "require": {
        "clicksign/clicksign-php": "*"
    }
}

然后，创建一个类似于 example/sample1.php 的文件来加载库

不使用composer安装

从 https://github.com/clicksign/clicksign-php/archive/master.zip 下载代码

将代码解压缩到一个文件夹中

然后，创建一个类似于 example/sample1.php 的文件来加载库

更完整的示例可以在 example/sample2.php 中找到

文档服务

列出所有文档

$docs = $client->documents->all();

foreach ($docs as $d)
{
    print $d->document->key;
}

上传文档

仅上传文件

$client->documents->upload("/Users/clicksign/Documents/Filename.pdf");

它还接受一个 $options 数组

$signers = array(array("email" => "jose.silva@example.com", "act" => "sign"), array("email" => "joao.souza@example.org", "act" => "witness"));
$message = "Please sign this document.";
$skipEmail = false;

$options = array("signers" => $signers, "message" => $message, "skipEmail" => $skipEmail);

$client->documents->upload("/Users/clicksign/Documents/Filename.pdf", $options);

此调用将上传文件并创建签名列表以及消息。如果传递了 $options 数组，则其中的 signers 数组是必须的。

注意：您必须强制使用UTF-8，否则在尝试发送除普通ASCII以外的任何内容时可能会收到服务器端错误。

检索文档

$doc = $client->documents->find("DOCUMENT_KEY");

print $doc->document->original_name;

下载文档

$file = $client->documents->download("DOCUMENT_KEY");

创建签名列表

$signers[0]["email"] = "jose.silva@example.com";
$signers[0]["act"] = "sign";

$signers[1]["email"] = "joao.souza@example.org";
$signers[1]["act"] = "witness";

$client->documents->createList("DOCUMENT_KEY", $signers);

或

$signers = array(array("email" => "jose.silva@example.com", "act" => "sign"), array("email" => "joao.souza@example.org", "act" => "witness"));
$client->documents->createList("DOCUMENT_KEY", $signers);

您可能需要传递 message 和 skip_email 参数

$client->documents->createList("DOCUMENT_KEY", $signers, "Hi guys, please sign this document.", false);

注意：您必须强制使用UTF-8，否则在尝试发送除普通ASCII以外的任何内容时可能会收到服务器端错误。

重新发送文档

$email = "jose.silva@example.com";
$message = "This is a reminder. Please sign the document";
$client->documents->resend("DOCUMENT_KEY", $email, $message);

取消文档

$client->documents->cancel("DOCUMENT_KEY");

钩子服务

创建钩子

$hook = $client->hooks->create("DOCUMENT_KEY", "http://example.com/clicksign/callback.php");

列出所有文档的钩子

$hooks = $client->hooks->all("DOCUMENT_KEY");

删除钩子

$client->hooks->delete("DOCUMENT_KEY", 2163);

批量服务

创建批量

$documentKeys = array("DOCUMENT_KEY_1", "DOCUMENT_KEY_2", "DOCUMENT_KEY_3");
$batch = $client->batches->create($documentKeys);

列出所有批量

$batches = $client->batches->all();

批量删除

$client->batches->delete("DOCUMENT_BATCH_KEY");

开发笔记

要为“供应商”组合包，请运行以下命令：composer install --no-dev --no-scripts（基于https://getcomposer.org.cn/doc/faqs/should-i-commit-the-dependencies-in-my-vendor-directory.md中的说明）