morningtrain/penneo-api

Penneo SDK for PHP

Monday, November 28, 2016
by morningtrain
Repository
5 Watchers
0 Stars
19 Installations

PHP
0 Dependents
0 Suggesters
3 Forks
0 Open issues
15 Versions
0 % Grown

The README.md

Penneo SDK for PHP

Penneo is all about digitizing the process of signing documents and contacts. The Penneo SDK for PHP enables PHP developers to use digital signing of documents in their PHP code. Get more info at penneo.com about how to become a customer., _(*1)

Prerequisites

The Penneo SDK for PHP requires that you are using PHP 5.3 or newer. Also you must have a recent version of cURL >= 7.16.2 compiled with OpenSSL and zlib., _(*2)

Getting Started

You can install the SDK by simply cloning or downloading the source, or you can use Composer. We recommend that you use Composer:, _(*3)

Installing via Composer

The recommended way to install the Penneo SDK is through Composer., _(*4)

# Install Composer
curl -sS https://getcomposer.org/installer | php

Next, update your project's composer.json file to include the SDK:, _(*5)

{
    "require": {
        "penneo/penneo-sdk-php": "1.*"
    }
}

After installing, you need to require Composer's autoloader:, _(*6)

require 'vendor/autoload.php';

You can find out more on how to install Composer, configure autoloading, and other best-practices for defining dependencies at getcomposer.org., _(*7)

Documentation

This section documents the different objects available through the SDK and how to use them., _(*8)

Authentication

In order to use the SDK, you will have to authenticate against the Penneo API. Authentication is done in a single line of code, using your Penneo API credentials:, _(*9)

// Initialize the connection to the API
Penneo\SDK\ApiConnector::initialize('apiKeyHere', 'apiSecretHere', $endpoint);

If you have a reseller account, you can carry out operations on behalf of one of your customers, by specifying the customer id as well:, _(*10)

// Initialize the connection to the API as customer
Penneo\SDK\ApiConnector::initialize('apiKeyHere','apiSecretHere', $endpoint, $customerId);

The endpoint url can point to either the sandbox (for testing) or the live system. Both endpoint urls are available on request., _(*11)

Document signing

Folders Folder objects are containers for case file objects.
Case files The case file object is a container used to bundle documents and signers. Every signing process starts with a case file.
Documents The document object represents (and contains) the actual PDF document.
Signature lines Every signable document must have at least one signature line. Think of it as the dashed line that people used to sign using a pen...
Signers A signer object represents the person that signs.
SigningRequests Think of the signing request as being the instructions for the signer on what to sign. It can either be the formal letter accompanying the document, the yellow post-its showing where to sign, or both.
Case file templates Instead of specifying the mapping between documents and signers explicitly, it is possible to use one of the many pre-defined case file templates provided by Penneo.

Identity validation

Validations Money laundering regulations require companies to validate the identity of their clients. The validation object can accomplish this, using only a social security number and an electronic ID.

Quick Examples

Signing a document (simple)

In this example, we show how to create a document with a single signer. The link to the Penneo signing portal, where the actual signing takes place, is printed as a result., _(*12)

namespace Penneo\SDK;

// Create a new case file
$myCaseFile = new CaseFile();
$myCaseFile->setTitle('Demo case file');
CaseFile::persist($myCaseFile);

// Create a new signable document in this case file
$myDocument = new Document($myCaseFile);
$myDocument->setTitle('Demo document');
$myDocument->setPdfFile('/path/to/pdfFile');
$myDocument->makeSignable();
Document::persist($myDocument);

// Create a new signer that can sign documents in the case file
$mySigner = new Signer($myCaseFile);
$mySigner->setName('John Doe');
Signer::persist($mySigner);

// Create a new signature line on the document
$mySignatureLine = new SignatureLine($myDocument);
$mySignatureLine->setRole('MySignerRole');
SignatureLine::persist($mySignatureLine);

// Link the signer to the signature line
$mySignatureLine->setSigner($mySigner);

// Update the signing request for the new signer
$mySigningRequest = $mySigner->getSigningRequest();
$mySigningRequest->setSuccessUrl('http://go/here/on/success');
$mySigningRequest->setFailUrl('http://go/here/on/failure');
SigningRequest::persist($mySigningRequest);

// "Package" the case file for "sending".
$myCaseFile->send();

// And finally, print out the link leading to the signing portal.
// The signer uses this link to sign the document.
print('<a href="'.$mySigningRequest->getLink().'">Sign now</a>');

Validating a person (money laundering regulations)

In this example we demontrate, how to validate a person from his/her electronic ID and social security number. The result is a link to the Penneo validation page. The person in question must follow the link and complete some actions in order to be validated., _(*13)

namespace Penneo\SDK;

// Create a new validation
$myValidation = new Validation();
$myValidation->setTitle('My new validation');
$myValidation->setName('John Doe');
Validation::persist($myValidation);

// Output the validation link.
print('<a href="'.$myValidation->getLink().'">Validate now</a>');

Resources

API documentation - Information about the Penneo API, methods and responses

The Versions

28/11 2016

dev-master

9999999-dev https://penneo.com

Penneo SDK for PHP

library penneo-api