mateusgalasso / clicksign
Laravel package for integration with Clicksign
1.0
2023-07-24 13:48 UTC
Requires
- php: >=8.1
- guzzlehttp/guzzle: ^7.0
- illuminate/support: ^10.0
README
Laravel package for integration with ClickSign services
Installation
You can install the package via composer:
composer require mateusgalasso/clicksign
fill in the required variables
CLICKSIGN_ACCESS_TOKEN=
CLICKSIGN_DEV_MODE=true //In production it must be false to get the clicksign production path
CLICKSIGN_DEV_URL=https://sandbox.clicksign.com
CLICKSIGN_PROD_URL=https://app.clicksign.com
Usage
To create a document
$response = (new Clicksign())->createDocument($path, $clicksignPath = null, $mimetype = 'application/pdf', $deadline = null, $autoClose = true, $locale = 'pt-BR', $sequence_enabled = false);
To create a signer
$response = (new Clicksign())->createSigner(String $email, String $name, $phoneNumber = null, $documentation = false, $birthday = null, $has_documentation = false);
To add a signer to the document
$response = (new Clicksign())->signerToDocument(String $document_key, $signer_key, $sign_as = 'approve', $message = null);
to view a document
$response = (new Clicksign())->visualizaDocumento($DocumentKey);
To Cancel Document
$response = (new Clicksign())->cancelDocument($DocumentKey);
To Delete Document
$response = (new Clicksign())->deleteDocument($DocumentKey);
To Notify Signer By Email
$response = (new Clicksign())->notificationsByEmail($signer_key, $message = null);
Changelog
Please see CHANGELOG for more information what has changed recently.
Security
If you discover any security related issues, please email mateusgalasso@yahoo.com.br instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.
Laravel Package Boilerplate
This package was generated using the Laravel Package Boilerplate.