README

本包的目的是简化与ClickSign服务的集成。支持多个企业（分支机构）的多凭证。

安装

要使用composer安装此包，请使用以下命令行

composer require cyberlpkf/clicksign

配置

对于使用单个企业的配置

填写以下变量

CLICKSIGN_USE_CONFIG_ON_DATABASE=false
CLICKSIGN_USE_INTEGRATION=false
CLICKSIGN_DEV_MODE=true
CLICKSIGN_DEV_URL=https://sandbox.clicksign.com
CLICKSIGN_PROD_URL=https://app.clicksign.com
CLICKSIGN_DOCUMENT_VERSION="/api/v1/documents"
CLICKSIGN_LIST_VERSION="api/v1/lists"
CLICKSIGN_NOTIFICATION_VERSION="/api/v1/notifications"
CLICKSIGN_SIGNERS_VERSION="api/v1/signers"
CLICKSIGN_DEV_ACCESS_TOKEN="SEU TOKEN PARA A ÁREA DE DESENVOLVIMENTO"
CLICKSIGN_PROD_ACCESS_TOKEN="SEU TOKEN PARA A ÁREA DE PRODUÇÃO"
CLICKSIGN_DOCUMENT_SIGN_DURATION=0

对于使用多个企业的配置

发布要执行的迁移

php artisan vendor:publish --provider="cyberlpkf\clicksign\ClickSignServiceProvider" --tag="migrations"

执行迁移

php artisan migrate

填写以下配置变量

CLICKSIGN_USE_CONFIG_ON_DATABASE=true

需要在表中创建一个记录以存储不同的配置。

字段内容

为了使ClickSign的配置被视为有效，以下属性必须在凭证字段中存在

如果未配置devMode属性，则将使用开发环境。

要使用数据库存储Clicksign的配置，需要在调用实际所需方法之前调用两个方法。需要配置apiId和filialId，应按以下方式操作

$response = (new Clicksign())
                ->setApiId(1)
                ->setFilialId(3)
                ->createDocument($path, $clicksignPath = null, $mimetype = 'application/pdf', $deadline = null, $autoClose = true, $locale = 'pt-BR', $sequence_enabled = false);

不配置ApiId将引发NoApiSetException异常。

不配置FilialId将引发NoFilialSetException异常。

用法

创建文档

$response = (new Clicksign())->createDocument($path, $clicksignPath = null, $mimetype = 'application/pdf', $deadline = null, $autoClose = true, $locale = 'pt-BR', $sequence_enabled = false);

不提供path将引发InvalidPathException异常。

创建签署者

$response = (new Clicksign())->createSigner(String $email, String $name, $phoneNumber = null, $documentation = false, $birthday = null, $has_documentation = false);

不提供name将引发InvalidNameException异常。

不提供email将引发InvalidEmailException异常。

将签署者添加到文档

$response =  (new Clicksign())->signerToDocument(String $DocumentKey, $SignerKey, $sign_as = 'approve', $message = null);

不提供DocumentKey将引发InvalidDocumentKeyException异常。

不提供#SignerKey*将引发InvalidSignerKeyException异常。

查看文档

$response =  (new Clicksign())->showDocument($DocumentKey);

不提供DocumentKey将引发InvalidDocumentKeyException异常。

取消文档

$response = (new Clicksign())->cancelDocument($DocumentKey);

不提供DocumentKey将引发InvalidDocumentKeyException异常。

删除文档

$response = (new Clicksign())->deleteDocument($DocumentKey);

不提供DocumentKey将引发InvalidDocumentKeyException异常。

通过电子邮件通知签署者

$response = (new Clicksign())->notificationsByEmail($SignerKey, $message = null);

不提供SignerKey将引发InvalidSignerKeyException异常。

测试

composer test

变更日志

查看变更日志文件以获取有关最近更改的更多信息。

贡献

有关贡献的更多详细信息，请参阅贡献指南。

安全

如果您发现任何与安全相关的问题，请通过电子邮件cyberlpkf@gmail.com联系。

贡献者

• Mateus Galasso（原始包）
• Luis Fernando Kieça

许可

MIT许可（MIT）。请参阅许可文件以获取更多信息。

Laravel包模板

本包使用Laravel包模板生成。