PHPackages macronlinebr/clicksign - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. macronlinebr/clicksign ActiveLibrary[API Development](/categories/api) macronlinebr/clicksign ====================== Pacote para integração com os serviços da ClickSign v1.0.1(1y ago)13MITPHPPHP ^8.2|^8.3 Since Feb 28Pushed 1y agoCompare [ Source](https://github.com/macronlinebr/clicksign)[ Packagist](https://packagist.org/packages/macronlinebr/clicksign)[ Docs](https://github.com/macronlinebr/clicksign)[ RSS](/packages/macronlinebr-clicksign/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (1)Dependencies (5)Versions (2)Used By (0) macronlinebr/clicksign ====================== [](#macronlinebrclicksign) [![Latest Version on Packagist](https://camo.githubusercontent.com/7903807023457f035af2343d456f924a2c7a4dbac66c24da2a9dfb96694aefd4/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6d6163726f6e6c696e6562722f636c69636b7369676e2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/macronlinebr/clicksign)[![Total Downloads](https://camo.githubusercontent.com/29e9967e070b6b5716afe19e1539df1aa37c1bfe52cd93b2b8e3902449848b83/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6d6163726f6e6c696e6562722f636c69636b7369676e2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/macronlinebr/clicksign) O objetivo deste pacote é facilitar a integração com os serviços do ClickSign. Suporta múltiplas credenciais para múltiplas empresas(filiais). Instalação ---------- [](#instalação) Para instalar este pacote via composer, use a seguinte linha de comando: ``` composer require macronlinebr/clicksign ``` Configuração ------------ [](#configuração) ### Para configuração utilizando uma única empresa [](#para-configuração-utilizando-uma-única-empresa) Preencha as seguintes variáveis: ``` CLICKSIGN_USE_CONFIG_ON_DATABASE=false CLICKSIGN_USE_INTEGRATION=false CLICKSIGN_ENVIRONMENT=dev CLICKSIGN_DEV_URL=https://sandbox.clicksign.com CLICKSIGN_PROD_URL=https://app.clicksign.com CLICKSIGN_DOCUMENT_VERSION="/api/v1/documents" CLICKSIGN_UPDATEDOCUMENT_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 ``` ### Para configuração utilizando múltiplas empresas [](#para-configuração-utilizando-múltiplas-empresas) Publique a migration a ser executada: ``` php artisan vendor:publish --provider="Macronlinebr\Clicksign\ClickSignServiceProvider" --tag="migrations" ``` Execute a migration: ``` php artisan migrate ``` Preencha a seguinte variável de configuração: ``` CLICKSIGN_USE_CONFIG_ON_DATABASE=true ``` Será necessário criar um registro na tabela api para armazenar as diferentes configurações. #### Conteúdo dos campos [](#conteúdo-dos-campos) CampoValorConteúdo**api\_id***seu valor*Contém a identificação da API. Você pode utilizar esta tabela para armazenar configuração de outras API's.**filial\_id***seu valor*Contém a identificação de uma filial. Este campo diferencia as diversas configurações de uma mesma API. No caso da ClickSign, use-o para identificar as diversas configurações a serem utilizadas.**credencial***seu valor*Contém a configuração da API no formato JSON. Configuração de outras API's também deverão ser armazenadas neste formato.Para que a configuração da ClickSign seja considerada como válida, os seguintes atributos deverão estar presentes no campo credencial: AtributoConteúdodocumentUrlVersionDeve armazenar a versão da API a ser utilizada para a gestão de documentos, como por exemplo */api/v1/documents* O não preenchimento deste atributo irá gerar a excessão *InvalidDocumentUrlConfigurationException*.updateDocumentUrlVersionDeve armazenar a versão da API a ser utilizada para a atualização de documentos, como por exemplo */api/v1/documents* O não preenchimento deste atributo irá gerar a excessão *InvalidUpdateDocumentUrlConfigurationException*.listUrlVersionDeve armazenar a versão da API a ser utilizada para a gestão de listas, como por exemplo */api/v1/lists* O não preenchimento deste atributo irá gerar a excessão *InvalidListUrlConfigurationException*.notificationUrlVersionDeve armazenar a versão da API a ser utilizada para as notificações, como por exemplo */api/v1/notifications* O não preenchimento deste atributo irá gerar a excessão *InvalidNotificationUrlConfigurationException*.signerUrlVersionDeve armazenar a versão da API a ser utilizada para a gestão das pessoas que irão assinar o documento, como por exemplo */api/v1/signers* O não preenchimento deste atributo irá gerara excessão *InvalidSignerUrlConfigurationException*.developmentUrlDeve armazenar a URL para a área de desenvolvimento (sandbox), como por exemplo ** O não preenchimento deste atributo irá gerar a excessão *InvalidDevelopmentUrlConfigurationException*.productionUrlDeve armazenar a URL para a área de produção, como por exemplo ** O não preenchimento deste atributo irá gerar a excessão *InvalidProductionUrlConfigurationException*.environmentDeve armazenar os valores *prod* ou *dev* indicando o ambiente a ser utilizado. *prod* indica o ambiente de produção e *dev* o ambiente sandbox.devAccessTokenDeve conter o token de acesso para a área de desenvolvimento. O não preenchimento deste atributo irá gerar a excessão *NoAccessTokenException*.prodAccessTokenDeve conter o token de acesso para a área de produção. O não preenchimento deste atributo irá gerar a excessão *NoAccessTokenException*.useIntegrationDeve conter true ou false indicando se a integração com a Clicksign será utilizada.documentSignDurationDeve conter a duração padrão para assinatura em dias. Deve ser maior que zero.> Caso o atributo *devMode* não esteja configurado, o ambiente de desenvolvimento será utilizado. Utilizar a opção de armazenar as configurações da Clicksign no banco de dados, requer que dois métodos sejam chamados *antes* de realizar a chamada efetiva do método desejado. Será necessário configurar o *apiId* e a *filialId* e deverá ser feito da seguinte maneira: ``` $response = (new Clicksign()) ->setApiId(1) ->setFilialId(3) ->createDocument($path, $clicksignPath = null, $mimetype = 'application/pdf', $deadline = null, $autoClose = true, $locale = 'pt-BR', $sequence_enabled = false); ``` > Não configurar *ApiId* irá gerar a exception *NoApiSetException*. > Não configurar *FilialId* irá gerar a exception *NoFilialSetException*. Usage ----- [](#usage) #### Para criar um documento [](#para-criar-um-documento) ``` $response = (new Clicksign())->createDocument($path, $clicksignPath = null, $mimetype = 'application/pdf', $deadline = null, $autoClose = true, $locale = 'pt-BR', $sequence_enabled = false); ``` > Não informar *path* irá gerar a excessão *InvalidPathException*. #### Para criar um signatário [](#para-criar-um-signatário) ``` $response = (new Clicksign())->createSigner(String $email, String $name, $phoneNumber = null, $documentation = false, $birthday = null, $has_documentation = false); ``` > Não informar *name* irá gerar a excessão *InvalidNameException*. > Não informar *email* irá gerar a excessão *InvalidEmailException*. #### Para adicionar um signatário a um documento [](#para-adicionar-um-signatário-a-um-documento) ``` $response = (new Clicksign())->signerToDocument(String $DocumentKey, $SignerKey, $sign_as = 'approve', $message = null); ``` > Não informar *DocumentKey* irá gerar a excessão *InvalidDocumentKeyException*. > Não informar #SignerKey\* irá gerar a excessão *InvalidSignerKeyException*. #### Para visualizar um documento [](#para-visualizar-um-documento) ``` $response = (new Clicksign())->showDocument($DocumentKey); ``` > Não informar *DocumentKey* irá gerar a excessão *InvalidDocumentKeyException*. #### Para cancelar um documento [](#para-cancelar-um-documento) ``` $response = (new Clicksign())->cancelDocument($DocumentKey); ``` > Não informar *DocumentKey* irá gerar a excessão *InvalidDocumentKeyException*. #### Para apagar um documento [](#para-apagar-um-documento) ``` $response = (new Clicksign())->deleteDocument($DocumentKey); ``` > Não informar *DocumentKey* irá gerar a excessão *InvalidDocumentKeyException*. #### Para notificar um signatário por e-mail [](#para-notificar-um-signatário-por-e-mail) ``` $response = (new Clicksign())->notificationsByEmail($SignerKey, $message = null); ``` > Não informar *SignerKey* irá gerar a excessão *InvalidSignerKeyException*. ### Testes [](#testes) ``` composer test ``` ### Changelog [](#changelog) Veja [o arquivo de alterações](CHANGELOG.md) mais finformações do que foi alterado recentemente. Contribuindo ------------ [](#contribuindo) Veja mais detalhes em [contribuindo](CONTRIBUTING.md). ### Segurança [](#segurança) Se você descobrir qualquer problema relacionado a segurança, por favor, entre em contato através do e-mail . Créditos -------- [](#créditos) - [Mateus Galasso](https://github.com/stonkeep) (pacote original) - [Luis Fernando Kieça](https://github.com/cyberlpkf) (pacote original) Licença ------- [](#licença) The MIT License (MIT). Por favor veja [o arquivo de licença](LICENSE.md) para mais informações. Laravel Package Boilerplate --------------------------- [](#laravel-package-boilerplate) This package was generated using the [Laravel Package Boilerplate](https://laravelpackageboilerplate.com). ### Health Score 29 — LowBetter than 60% of packages Maintenance44 Moderate activity, may be stable Popularity5 Limited adoption so far Community6 Small or concentrated contributor base Maturity52 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Unknown Total 1 Last Release 436d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/2d6cfccd607043585ca08b3dd9a582451af0842508d3d04f8e908d664fb0c381?d=identicon)[macronlinebr](/maintainers/macronlinebr) --- Top Contributors [![CyberLPKF](https://avatars.githubusercontent.com/u/26222825?v=4)](https://github.com/CyberLPKF "CyberLPKF (47 commits)") --- Tags clicksignmacronlinebr ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/macronlinebr-clicksign/health.svg) ``` [![Health](https://phpackages.com/badges/macronlinebr-clicksign/health.svg)](https://phpackages.com/packages/macronlinebr-clicksign) ``` ### Alternatives [mollie/laravel-mollie Mollie API client wrapper for Laravel & Mollie Connect provider for Laravel Socialite 3624.1M28](/packages/mollie-laravel-mollie)[mll-lab/laravel-graphiql Easily integrate GraphiQL into your Laravel project 683.2M9](/packages/mll-lab-laravel-graphiql)[esign/laravel-conversions-api A laravel wrapper package around the Facebook Conversions API 69145.4k](/packages/esign-laravel-conversions-api)[didww/didww-api-3-php-sdk PHP SDK for DIDWW API 3 1218.2k](/packages/didww-didww-api-3-php-sdk)[surface/laravel-webfinger A Laravel package to create an ActivityPub webfinger. 113.8k](/packages/surface-laravel-webfinger) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)