README

DigiSign PHP 库 - 使用 PSR-18 HTTP Client、PSR-17 HTTP Factories 和 PSR-16 SimpleCache 在 PHP 中与 https://api.digisign.org 通信

API 文档在这里 https://api.digisign.org/api/docs

安装

通过 Composer

$ composer require digitalcz/digisign

配置

PHP 中的示例配置

use DigitalCz\DigiSign\Auth\ApiKeyCredentials;
use DigitalCz\DigiSign\DigiSign;

// Via constructor options
$dgs = new DigiSign([
    'access_key' => '...', 
    'secret_key' => '...'
]);

// Or via methods
$dgs = new DigiSign();
$dgs->setCredentials(new ApiKeyCredentials('...', '...'));

可用的构造函数选项

• access_key - 字符串；ApiKey 访问密钥
• secret_key - 字符串；ApiKey 密钥
• credentials - DigitalCz\DigiSign\Auth\Credentials 实例
• client - DigitalCz\DigiSign\DigiSignClient 实例，带有您自定义的 PSR17/18 对象
• http_client - Psr\Http\Client\ClientInterface 实例，您的自定义 PSR18 客户端
• cache - Psr\SimpleCache\CacheInterface 用于缓存 Credentials Tokens
• testing - 布尔值；是否使用测试或生产 API
• api_base - 字符串；覆盖基本 API URL
• signature_tolerance - 整数；webhook 签名年龄验证的容忍度（以秒为单位）

可用的配置方法

use DigitalCz\DigiSign\Auth\Token;
use DigitalCz\DigiSign\Auth\TokenCredentials;
use DigitalCz\DigiSign\DigiSign;
use DigitalCz\DigiSign\DigiSignClient;
use Symfony\Component\Cache\Adapter\FilesystemAdapter;
use Symfony\Component\Cache\Psr16Cache;
use Symfony\Component\HttpClient\Psr18Client;

$dgs = new DigiSign();
// To set your own PSR-18 HTTP Client, if not provided Psr18ClientDiscovery is used
$dgs->setClient(new DigiSignClient(new Psr18Client()));
// If you already have the auth-token, i can use TokenCredentials
$dgs->setCredentials(new TokenCredentials(new Token('...', 123)));
// Cache will be used to store auth-token, so it can be reused in later requests
$dgs->setCache(new Psr16Cache(new FilesystemAdapter()));
// Use testing API (https://api.digisign.digital.cz)
$dgs->useTesting(true);
// Overwrite API base
$dgs->setApiBase('https://example.com/api');
// Set maximum age of webhook request to one minute
$dgs->setSignatureTolerance(60);

在 Symfony 中的示例配置

services:
  DigitalCz\DigiSign\DigiSign:
    $options:
      # minimal config
      access_key: '%digisign.accessKey%'
      secret_key: '%digisign.secretKey%'
      
      # other options
      cache: '@psr16.cache'
      http_client: '@psr18.http_client'
      testing: true # use testing API

用法

创建并发送信封

$dgs = new DigitalCz\DigiSign\DigiSign(['access_key' => '...', 'secret_key' => '...']);

$envelopes = $dgs->envelopes();

$envelope = $envelopes->create([
    'emailSubject' => 'Please sign',
    'emailBody' => 'Hello James, please sign these documents.',
    'senderName' => 'John Smith',
    'senderEmail' => 'john.smith@example.com'
]);

$recipient = $envelopes->recipients($envelope)->create([
    'role' => 'signer',
    'name' => 'James Brown',
    'email' => 'james42@example.com',
    'mobile' => '+420775300500',
]);

$stream = DigitalCz\DigiSign\Stream\FileStream::open('path/to/document.pdf');
$file = $dgs->files()->upload($stream);

$document = $envelopes->documents($envelope)->create([
    'name' => 'Contract',
    'file' => $file->self()
]);

$tag = $envelopes->tags($envelope)->create([
    'type' => 'signature',
    'document' => $document,
    'recipient' => $recipient,
    'page' => 1,
    'xPosition' => 200,
    'yPosition' => 340
]);

$envelopes->send($envelope->id());

查看 示例 以获取更多信息

变更日志

请参阅 CHANGELOG 了解最近更改的详细信息。

测试

$ composer csfix    # fix codestyle
$ composer checks   # run all checks 

# or separately
$ composer tests    # run phpunit
$ composer phpstan  # run phpstan
$ composer cs       # run codesniffer

贡献

请参阅 CONTRIBUTING 了解详细信息。

安全

如果您发现任何安全问题，请通过电子邮件 devs@digital.cz 报告，而不是使用问题跟踪器。

致谢

• Digital Solutions s.r.o.
• 所有贡献者

许可

MIT 许可证 (MIT)。请参阅 许可文件 了解更多信息。