Download the PHP package tylermenezes/legalesign-php without Composer
On this page you can find all versions of the php package tylermenezes/legalesign-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tylermenezes/legalesign-php
More information about tylermenezes/legalesign-php
Files in tylermenezes/legalesign-php
Package legalesign-php
Short Description Library for working with the Legalesign API.
License Artistic
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 legalesign-php
Legalesign-PHP
A PHP-based interface to Legalesign.
Use
Include it with Composer:
composer require tylermenezes/legalesign-php
Set your credentials
You can view your API credentials at the bottom of your user page. Non-sandboxed use currently requires a paid plan, but you can test your integration in the sandbox. (When in sandbox mode, you will only be able to send requests to five emails you specify on your profile page.)
You can set your credentials like so:
If you use Laravel, credentials will automatically be pulled from a legalesign.php config file, if one exists. The
format of this file should be:
Change API Base URL
For some reasons, some accounts do not work with https://api.legalesign.com/api/v1.
You can change your Base API URL by calling apiBase() method.
Create a signer
Create a signing request
The Document::create() method actually returns a Document\SigningRequest object, which will allow you to configure
your signing request. As shown above, you should configure properties by chaining method calls with the names of the
properties you'd like to set.
The following properties are supported:
groupId(required): the ID of the group to which the document should belong. If you're not sure what this ID is, the easiest way to find it is to hover over your company name in the header. The group ID will be in the last part of the URL.name(required): the company name.userId: the ID of the user from which the document should be sent. You can leave this blank for the default.appendLegalesignValidationInfo(default true): If true, a page will be added to the document with audit logs.autoArchive(default true): Automatically archive the document after completion. This mostly just hides it from the dashboard.signaturesOnAllPages(default false): If true, show signatures on all pages. Otherwise, only show them on the last page.certify(default true): If true, Legalesign should certify the PDF. This is recommended.signInOrder(default true): If true, the second signer cannot sign until the first has signed, etc. Signing order is the order in which you add signers.password(default null): If set, the PDF will be password protected with the set password.storePassword(default false): If a password is set, this affects whether Legalesign saves the password.footer,footerHeight,header,headerHeight(all default null): If set, these control the footer and header.pdfText(default []): If set, the PDF sender fields will be pre-filled according to these values.signerText(default []): If set, the PDF signer fields will be pre-filled according to these values.
You can also add signers and cc'ers (people who will be cc'd on all emails) with the addSigner and addCc methods.
To actually send the document, end the chain with one of the following three methods:
sendWithHtml($html): Specifies the document to send in HTML, and sends it.sendWithTemplateHtml($template): Specifies an HTML template to use for the document, and sends it.sendWithTemplatePdf($template): Specifies a PDF template to use for the document, and sends it.
All of these methods return a Document, of which you should generally save the id.
Get signer fields
The getSignerFields() method returns an associative array of all your signer fields. Refer below for the sample format:
