README

安装

composer require np-digital/api

配置

将dist/.env复制到您的根目录，并添加您的Penneo密钥、密钥和API端点。

PENNEO_API_KEY=
PENNEO_API_SECRET=
PENNEO_API_URI=

端点 sandbox.penneo.com/api/v3/或app.penneo.com/api/v3/。

用法

创建一个包含2个文档和2个签署人的新casefile，通过电子邮件联系他们进行文档签署。

require_once ( $_SERVER['DOCUMENT_ROOT'] . '/vendor/autoload.php');

use Symfony\Component\Dotenv\Dotenv;
use NPDigital\Api\Penneo;

$dotenv = new Dotenv();
$dotenv->load( $_SERVER['DOCUMENT_ROOT'] .'/.env');

$casefile = Penneo::casefile();
$folder = $casefile->getFolder('Temp');
$template = $casefile->getTemplate('Ansættelsesaftale');

$signers = [
	['name' => 'Wendy Willard', 'representing' => 'Self', 'email' => 'wendy.willard@yahoo.com', 'signerTypeId' => 0],
	['name' => 'Sam Samson', 'representing' => 'Acme Inc', 'email' => 'sam@acme.io', 'signerTypeId' => 1]
];
$documents = [
	['title' => 'StartPepple employment agreement', 'filename' => __DIR__.'/contract.pdf', 'documentTypeId' => 0],
	['title' => 'StartPepple Aps - general terms', 'filename' => __DIR__.'/terms.pdf', 'documentTypeId' => 1],
	['title' => 'StartPepple Aps - appendix', 'filename' => __DIR__.'/appendix.pdf', 'documentTypeId' => 2],
];

$response = $casefile->create(
	title: 'StartPeople employment contract ' . date('ymd-Hi'), 
	documents: $documents, 
	signers: $signers,
	template: $template,
	folder: $folder
)->send();

echo $response;

创建包含相同数据的草案。

Penneo::casefile()->create(
	title: 'Start Pebble employment contract', 
	documents: $documents, 
	signers: $signers
)

使用casefile id获取casefile摘要。

$casefile = Penneo::casefile( casefileId: 447255 )->parse();
print_r($casefile->response);

发送草案。

Penneo::casefile( casefileId: 7466435 )->send();

实体获取器

通过名称或id返回一个Folder对象。

$folder = $casefile->getFolder([$name | $id]);

通过名称或id返回一个CaseFileTemplate对象。

$template = $casefile->getTemplate([$name | $id]);

Casefile获取器

通过casefileId返回所有Casefile Documents。

$documents = Penneo::casefile( $casefileId )->getDocuments();

通过casefileId返回所有Casefile Signers。

$documents = Penneo::casefile( $casefileId )->getSigners();

辅助函数

可用文件夹

$folders = Penneo::casefile()->getFolders();
var_dump($folders);

可用模板

$template_list = Penneo::casefile()->getTemplates();
var_dump($template_list);

模板结构

$templateStructure = Penneo::casefile()->setTemplate($templateId)->showTemplate();
var_dump($templateStructure);