README

安装

使用 composer 安装，如下所示

composer require forward-force/rightSignature-api-sdk

用法

身份验证

为了进行身份验证，您需要传递如下所示的 私有 API 令牌

$rightSignature = new RightSignature($token); //pv_deec47538d80245234a66e1d14d38be81

示例

获取所有文档

$rightSignature = new RightSignature($token);

try {
    $documents = $rightSignature->documents()->fetch();
    var_dump($documents);
} catch (GuzzleException $e) {
    var_dump($e->getMessage());
}

通过 ID 获取文档

$document = $rightSignature->documents()->getById('fcc2517e-c596-4d91-9f59-112a292eb643');

克隆模板，准备模板（填充合并字段），并发送给签字者

$signer1 = ['name' => 'buyer_signer', 'signer_email' => 'foo@example.com', 'signer_name' => 'John Doe'];
$signer2 = ['name' => 'seller_signer', 'signer_email' => 'bar@example.com', 'signer_name' => 'Jane Smith'];

$document = $rightSignature->documents()
    ->addBodyParameter('roles', [$signer1, $signer2])
    ->addBodyParameter('reusable_template', [
        'roles' => [$signer1, $signer2]
    ])
    ->addBodyParameter("message", "Please sign this")
    ->addBodyParameter('name', 'Name 1')
    ->addMergeField('client_name', 'The Client')
    ->sendDocument('fcc2517e-c596-4d91-9f59-112a292eb643');

获取所有可重用模板

try {
    $documents = $rightSignature->documents()->fetchReusableTemplates();
    var_dump($documents);
} catch (GuzzleException $e) {
    var_dump($e->getMessage());
}

通过 ID 获取可重用模板

$document = $rightSignature->documents()->getReusableTemplateById('fcc2517e-c596-4d91-9f59-112a292eb643');

贡献

要本地运行，您可以使用此处提供的 docker 容器。您可以这样运行它

docker-compose up

有关在本地运行此库的自动生成文档，请参阅 phpdocker/README.md

如果您发现问题、有疑问或建议，请随时在 github 上提交问题。

致谢

感谢 phpdocker.io 使获取 PHP 环境变得如此简单！