DocuSign.eSign 1.0.1

DocuSign.eSign 1.0.1

×

测试已测试✗
Lang语言 Obj-CObjective C
许可证 自定义
发布最新版本2016年1月

由 Naveen Gopala 维护。

 
依赖
AFNetworking~> 2.3
JSONModel~> 1.1
ISO8601~> 0.3
 

DocuSign.eSign 1.0.1

  • 由
  • 开发者中心

DocuSign Objective-C 客户端

官方的 DocuSign Objective-C 客户端基于 DocuSign REST API，并提供了 Objective-C 应用程序集成的库。建议您为新的开发使用此版本客户。

官方的 DocuSign 电子签名 Objective-C 客户端基于 DocuSign REST API 的第 2 版，并提供了 Objective-C 应用程序集成的库。建议您为新的开发使用此版本的库。

获取客户端库

库可在 DocuSign GitHub 仓库中找到。您可以从 https://github.com/docusign/docusign-objc-client 下载它。您可以将其作为 zip 文件下载或克隆仓库。

master 分支包含最新版本。

仓库组织

  • \sdk：客户端的源代码
  • \test：单元测试和示例代码
    • \test\Recipes\：DocuSign recepies 的源代码。CoreRecipes.m 包含核心 recepies 的示例代码。
    • \test\dkTests\SdkTests\test\SDKTests\SDKTestsTests\SDKTestsTests.m：库的单元测试。

安装客户端库

使用客户端的主要有两种方式

  • 直接将源文件复制到您现有项目的源目录中并导入。

  • 创建 podfile，运行 pod install，然后继续使用 .xcworkspace 项目文件。要以此方式使用客户端，请按以下步骤操作

    1. 在命令行中运行以下 RubyGems 命令以安装 Cocoapods（注意：这可能需要 sudo）：$ gem install cocoapods

    2. 在您的根项目目录中创建一个名为 podfile 的文件，并包含以下内容：pod "DocuSignESignClient", :path => "./sdk"

    3. 在 podfile 相同的目录中运行以下命令：$ pod install

安装完成后，关闭 Xcode 并打开新创建的 .xcworkspace 项目文件。确保您继续使用此工作空间！

确保在源中添加您的导入语句，例如

#import <DocuSignESignClient/DSApiClient.h>
#import <DocuSignESignClient/DSAuthenticationApi.h>
#import <DocuSignESignClient/DSEnvelopesApi.h>

依赖项

AFNetworking ~> 2.3 JSONModel ~> 1.1 ISO8601 ~> 0.3

关于客户端库

客户端库实现了REST API方法的一个子集。库是通过Swagger-codegen和自定义Swagger模板自动生成的。因此，客户端是一个代理和一组用于调用DocuSign REST API的模型。使用客户端库为Objective-C开发者提供比直接使用REST更熟悉的接口，并消除了创建REST请求和响应类型自定义Objective-C模型的需求。

客户端库与REST API之间的差异

此版本的客户端库没有实现DocuSign REST API的所有方法。当前客户端省略了Accounts、Billing、Cloud Storage、Connect、Groups（品牌）和Templates（批量收件人）类别中的方法。客户端的方法支持开发者新接触DocuSign集成的核心用例。

有关省略端点的完整列表，请参阅省略端点主题。

下一步操作

要使用客户端库，请创建一个免费的开发者账户并获得一个集成者密钥。

您将使用您的登录电子邮件、密码和集成者密钥，通过AuthenticationApi.login函数对DocuSign平台进行身份验证。

此调用以及其他示例在DocuSign集成菜谱中进行演示。

注意事项

虽然开发者网站为您提供了全面的平台功能访问权限，但您可以在应用程序中使用哪些特性将取决于您或您的客户选择的生产账户类型。

许多API函数都有一个重载版本，它提供了一个"选项"对象。这些通常是可选参数，对应于REST API中的查询字符串参数，并用于修改正在进行的请求。

检查提交信封状态

当信封或收件人的状态发生变化时，您的应用程序可以通过DocuSign平台向您的应用程序发出通过webhook的调用或轮询信封状态。

Webhook：在创建信封调用的请求体中使用eventNotification元素来注册您的回调webhook。此功能支持所有账户类型，并且由DocuSign推荐，优先于轮询平台。

轮询：EnvelopesApi.listStatusChanges()方法在其选项列表中有必选参数，称为fromDate。必须设置此参数才能成功调用该函数。我们建议将其设置为在尽可能短的时间内检索文档；建议设置为24或48小时。此外，DocuSign不允许应用程序每15分钟轮询一次以上。有关更多信息，请参阅轮询信封状态菜谱。

提交文档

REST API支持使用多部分表单数据输入提交请求以创建包含签名文档的DocuSign信封。此格式需要一个包含JSON的段，后面跟一个或多个多部分请求的段，包含文档的二进制字节以及包含文档ID和文件名的头信息。

在客户端库中，通过允许将文档指定为JSON请求的一部分作为base64字符串来简化了这一过程。请参阅通过电子邮件请求签名菜谱中的示例。

“Hello World”示例

请参阅DocuSign 开发者中心快速入门和API菜谱以获取“Hello World”示例。

有疑问吗？请通过StackOverflow提问，添加标签“docusignapi。”DocuSign 专业服务以及我们的合作伙伴也可供您协助。