Download the PHP package cyberlpkf/clicksign without Composer
On this page you can find all versions of the php package cyberlpkf/clicksign. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download cyberlpkf/clicksign
More information about cyberlpkf/clicksign
Files in cyberlpkf/clicksign
Package clicksign
Short Description Pacote para integração com os serviços da ClickSign
License MIT
Homepage https://github.com/cyberlpkf/clicksign
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package clicksign
cyberlpkf/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
Para instalar este pacote via composer, use a seguinte linha de comando:
Configuração
Para configuração utilizando uma única empresa
Preencha as seguintes variáveis:
Para configuração utilizando múltiplas empresas
Publique a migration a ser executada:
Execute a migration:
Preencha a seguinte variável de configuração:
Será necessário criar um registro na tabela api para armazenar as diferentes configurações.
Conteúdo dos campos
| Campo | Valor | Conteú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:
| Atributo | Conteúdo |
|---|---|
| documentUrlVersion | Deve 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. |
| updateDocumentUrlVersion | Deve 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. |
| listUrlVersion | Deve 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. |
| notificationUrlVersion | Deve 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. |
| signerUrlVersion | Deve 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. |
| developmentUrl | Deve armazenar a URL para a área de desenvolvimento (sandbox), como por exemplo https://sandbox.clicksign.com O não preenchimento deste atributo irá gerar a excessão InvalidDevelopmentUrlConfigurationException. |
| productionUrl | Deve armazenar a URL para a área de produção, como por exemplo https://app.clicksign.com O não preenchimento deste atributo irá gerar a excessão InvalidProductionUrlConfigurationException. |
| environment | Deve armazenar os valores prod ou dev indicando o ambiente a ser utilizado. prod indica o ambiente de produção e dev o ambiente sandbox. |
| devAccessToken | Deve conter o token de acesso para a área de desenvolvimento. O não preenchimento deste atributo irá gerar a excessão NoAccessTokenException. |
| prodAccessToken | Deve conter o token de acesso para a área de produção. O não preenchimento deste atributo irá gerar a excessão NoAccessTokenException. |
| useIntegration | Deve conter true ou false indicando se a integração com a Clicksign será utilizada. |
| documentSignDuration | Deve 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:
Não configurar ApiId irá gerar a exception NoApiSetException.
Não configurar FilialId irá gerar a exception NoFilialSetException.
Usage
Para criar um documento
Não informar path irá gerar a excessão InvalidPathException.
Para criar um signatário
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
Não informar DocumentKey irá gerar a excessão InvalidDocumentKeyException.
Não informar #SignerKey irá gerar a excessão InvalidSignerKeyException*.
Para visualizar um documento
Não informar DocumentKey irá gerar a excessão InvalidDocumentKeyException.
Para cancelar um documento
Não informar DocumentKey irá gerar a excessão InvalidDocumentKeyException.
Para apagar um documento
Não informar DocumentKey irá gerar a excessão InvalidDocumentKeyException.
Para notificar um signatário por e-mail
Não informar SignerKey irá gerar a excessão InvalidSignerKeyException.
Testes
Changelog
Veja o arquivo de alterações mais finformações do que foi alterado recentemente.
Contribuindo
Veja mais detalhes em contribuindo.
Segurança
Se você descobrir qualquer problema relacionado a segurança, por favor, entre em contato através do e-mail [email protected].
Créditos
- Mateus Galasso (pacote original)
- Luis Fernando Kieça
Licença
The MIT License (MIT). Por favor veja o arquivo de licença para mais informações.
Laravel Package Boilerplate
This package was generated using the Laravel Package Boilerplate.
All versions of clicksign with dependencies
illuminate/support Version ^8.0
michaelachrisco/readonly Version ^0.60.1
staudenmeir/eloquent-json-relations Version ^1.5.4