timgws / docusign
DocuSign eSign PHP 客户端库
This package is auto-updated.
Last update: 2024-09-08 11:09:04 UTC
README
这是一个客户端库,可以帮助您开始使用 DocuSign eSignature API。要开始使用此库,请访问 http://www.docusign.com/devcenter 并获取一个免费的开发者账户。在您获得账户并生成集成器密钥(应用程序密钥)后,您将能够进行测试 Web 服务调用。要生成集成器密钥,请登录您的开发者账户并转到首选项 -> API 页面。
JSON 解析是通过 PHP 的原生 json_encode()
和 json_decode()
函数完成的,这些函数在 PHP 5.2.x 及更高版本中可用。要查看如何使用此库进行最常用场景的示例,请查看测试目录。子文件夹包含单元测试,以及 /examples 文件夹,展示了最常用的使用场景。
注意:它不具备 DocuSign 服务的全部功能。您可以自由地更新代理类并贡献功能。或者,您可以获取原始 HTTP 连接并发送自己的 JSON。要获取完整功能和文档,请访问 www.docusign.com/devcenter 和 iodocs.docusign.com
库配置
要使用此库,您需要将您的账户特定信息输入到 config.php
配置文件中。测试数据也可以输入到 testConfig.php
文件中进行单元测试和示例。搜索字符串 "TODO" 以找到需要输入特定信息的位置。
系统要求
- PHP 5.2.x 或更高版本 [https://php.ac.cn/]
- PHP Curl 扩展 [https://php.ac.cn/manual/en/intro.curl.php]
- PHP JSON 扩展 [https://php.ac.cn/manual/en/book.json.php]
此客户端库已与 PHP 5.3.15 进行了测试。
重要术语
集成器密钥
:标识单个集成。每个 API 请求都包含集成器密钥和用户名/密码组合
信封
:就像一个正常的邮政信封。它包含诸如文档、收件人和标签等内容
文档
:您想要签名的 PDF、Doc、图片或其他项目。如果它不是 PDF,您必须在 API 调用中包含文件扩展名
标签
:与文档上的位置相关联,并定义了那里的操作。例如,您在需要收件人签名的地方有一个 "签名此处" 标签
收件人
:您想要发送信封的人。需要用户名和电子邮件
受控收件人
:收件人在您的网站上通过 iframe 签名,而不是接收电子邮件。受控收件人具有 clientUserId 属性
PowerForm
:一个预先创建的信封,您可以启动它而不是编写服务器端代码
速率限制
请注意:应用程序不允许每 15 分钟多次轮询信封状态,我们不建议集成器从终端状态(已完成、拒绝和作废)的信封中连续检索状态。过度轮询会导致您的 API 访问被撤销。
如果您需要立即通知信封事件,我们鼓励您查看信封事件或使用我们的Connect Publisher技术,将DocuSign Connect作为替代方案。
更多信息
专业服务也可用,以帮助您快速定义和实施项目。
您也可以在StackOverflow上找到很多已解答的问题,搜索标签 DocuSignApi
: http://stackoverflow.com/questions/tagged/docusignapi