DigiSign PHP library - provides communication with https://api.digisign.org in PHP using PSR-18 HTTP Client, PSR-17 HTTP Factories and PSR-16 SimpleCache.
API documentation is here https://api.digisign.org/api/docs
Via Composer
$ composer require digitalcz/digisignuseDigitalCz\DigiSign\Auth\ApiKeyCredentials;
useDigitalCz\DigiSign\DigiSign;
// Via constructor options$dgs = newDigiSign([
'access_key' => '...', 'secret_key' => '...'
]);
// Or via methods$dgs = newDigiSign();
$dgs->setCredentials(newApiKeyCredentials('...', '...'));access_key- string; ApiKey access keysecret_key- string; ApiKey secret keycredentials- DigitalCz\DigiSign\Auth\Credentials instanceclient- DigitalCz\DigiSign\DigiSignClient instance with your custom PSR17/18 objectshttp_client- Psr\Http\Client\ClientInterface instance of your custom PSR18 clientcache- Psr\SimpleCache\CacheInterface for caching Credentials Tokenssandbox- bool; whether to use sandbox or production APIapi_base- string; override the base API urlsignature_tolerance- int; The tolerance for webhook signature age validation (in seconds)
useDigitalCz\DigiSign\Auth\Token;
useDigitalCz\DigiSign\Auth\TokenCredentials;
useDigitalCz\DigiSign\DigiSign;
useDigitalCz\DigiSign\DigiSignClient;
useSymfony\Component\Cache\Adapter\FilesystemAdapter;
useSymfony\Component\Cache\Psr16Cache;
useSymfony\Component\HttpClient\Psr18Client;
$dgs = newDigiSign();
// To set your own PSR-18 HTTP Client, if not provided Psr18ClientDiscovery is used$dgs->setClient(newDigiSignClient(newPsr18Client()));
// If you already have the auth-token, i can use TokenCredentials$dgs->setCredentials(newTokenCredentials(newToken('...', 123)));
// Cache will be used to store auth-token, so it can be reused in later requests$dgs->setCache(newPsr16Cache(newFilesystemAdapter()));
// Use sandbox API (https://api.staging.digisign.org)$dgs->useSandbox(true);
// Overwrite API base$dgs->setApiBase('https://example.com/api');
// Set maximum age of webhook request to one minute$dgs->setSignatureTolerance(60);services:
DigitalCz\DigiSign\DigiSign:
$options:
# minimal configaccess_key: '%digisign.accessKey%'secret_key: '%digisign.secretKey%'# other optionscache: '@psr16.cache'http_client: '@psr18.http_client'sandbox: true # use sandbox API$dgs = newDigitalCz\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());See examples for more
Please see CHANGELOG for more information on what has changed recently.
$ composer csfix # fix codestyle
$ composer checks # run all checks # or separately
$ composer tests # run phpunit
$ composer phpstan # run phpstan
$ composer cs # run codesnifferPlease see CONTRIBUTING for details.
If you discover any security related issues, please email devs@digital.cz instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.