Signaturit 1.3.0

Signaturit 1.3.0

×

测试已测试✗
Lang语言 SwiftSwift
许可证 MIT
发布最后发布2019年4月
SPM支持 SPM✗

由 Signaturit 维护。

Signaturit 1.3.0

  • 由
  • Signaturit

不要使用主分支

要发布一个新版本

  • 修改 Signaturit.podspect 的 VERSION。
  • 修改 User Agent 的 VERSION。
  • git commit --allow-empty -m "Release VERSION"
  • git tag VERSION
  • git push origin master
  • git push origin VERSION
  • pod spec lint Signaturit.podspec --allow-warnings
  • pod trunk register [email protected] Signaturit
  • pod trunk push Signaturit.podspec --allow-warnings

Signaturit Swift SDK

这个包是围绕 Signaturit API 的 Swift 封装。如果您还没有阅读文档，现在可能是时候查看了。详情请见 这里。

配置

推荐的方法是通过Cocoapods安装SDK。

您可以使用Cocoapods安装Signaturit，将其添加到您的Podfile中。

platform :ios, '8.0'
use_frameworks!

target 'MyApp' do
    pod 'Signaturit'
end

请注意，默认情况下，客户端将使用我们的沙盒API。当您准备好开始使用生产环境时，只需获取正确的访问令牌并将额外的参数传递给构造函数。

let Signaturit = Signaturit(accessToken: "YOUR_ACCESS_TOKEN")

示例

签名

计算签名请求数量

计算您的签名请求数量。

client.countSignatures().responseJSON { response in
    print(response)
}

获取所有签名请求

使用不同的过滤器检索您的签名请求的所有数据。

所有签名
client.getSignatures().responseJSON { response in
    print(response)
}
获取最后50个签名
client.getSignatures(50).responseJSON { response in
    print(response)
}
使用自定义字段“crm_id”获取签名
let params = ["crm_id": "CUSTOM_ID"]
client.getSignatures(100, offset: 0, conditions: params).responseJSON { response in
    print(response)
}

获取签名请求

通过传递其ID来获取单个签名请求的相关信息。

client.getSignature("SIGNATURE_ID").responseJSON { response in
    print(response)
}

签名请求

创建一个新的签名请求。您可以检查所有签名 参数。

let file       = NSBundle.mainBundle().URLForResource("Document", withExtension: "pdf")
let recipients = [["email": "[email protected]", "name": "John Doe"]]
let params     = ["subject": "Receipt no. 250", "body": "Please sign the receipt"]

client.createSignature([file], recipients: recipients, params: params, successHandler: { response in
    print(response)
})

您可以在请求中添加自定义信息

let file       = NSBundle.mainBundle().URLForResource("Document", withExtension: "pdf")
let recipients = [["email": "[email protected]", "name": "John Doe"]]
let params     = ["subject": "Receipt no. 250", "body": "Please sign the receipt", "data": ["crm_id": "45673"]]

client.createSignature([file], recipients: recipients, params: params, successHandler: { response in
    print(response)
})

您可以发送带有填写字段的模板

let file       = NSBundle.mainBundle().URLForResource("Document", withExtension: "pdf")
let recipients = [["email": "[email protected]", "name": "John Doe"]]
let params     = ["subject": "Receipt no. 250", "body": "Please sign the receipt", "templates": ["template_name"]]

client.createSignature([], recipients: recipients, params: params, successHandler: { response in
    print(response)
})

取消签名请求

取消签名请求。

client.cancelSignature("SIGNATURE_ID").responseJSON { response in
    print(response)
}

发送提醒

发送提醒电子邮件。

client.sendSignatureReminder("SIGNATURE_ID").responseJSON { response in
    print(response)
}

获取审计日志

获取签名请求文档的审计日志

let path = Alamofire.Request.suggestedDownloadDestination(directory: .DocumentDirectory, domain: .UserDomainMask)

client.downloadAuditTrail("SIGNATURE_ID", documentId: "DOCUMENT_ID", path: path).responseJSON { response in
    print(response)
}

获取已签署文档

获取签名请求文档的已签署文档

let path = Alamofire.Request.suggestedDownloadDestination(directory: .DocumentDirectory, domain: .UserDomainMask)

client.downloadSignedDocument(SIGNATURE_ID, documentId: "DOCUMENT_ID", path: path).responseJSON { response in
    print(response)
}

品牌化

获取品牌化

获取所有账户品牌化。

client.getBrandings().responseJSON { response in
    print(response)
}

获取品牌化

获取单个品牌化。

client.getBranding("BRANDING_ID").responseJSON { response in
    print(response)
}

创建品牌化

创建一个新的品牌化。您可以检查所有品牌化 参数。

let params = [
    "layout_color": "#FFBF00",
    "text_color": "#2A1B0A",
    "application_texts": ["sign_button": "Sign!"]
]

client.createBranding(params).responseJSON { response in
    print(response)
}

更新品牌化

更新单个品牌化。

let params = ["application_texts" => ["send_button" => "Send!"]]

client.updateBranding("BRANDING_ID", params: params).responseJSON { response in
    print(response)
}

模板

获取所有模板

从您的模板中检索所有数据。

client.getTemplates().responseJSON { response in
    print(response)
}

电子邮件

获取电子邮件

####获取所有认证的电子邮件

response = client.getEmails().responseJSON { response in
    print(response)
}

####获取最后50封电子邮件

response = client.getEmails(50).responseJSON { response in
    print(response)
}

####在50个结果的块中导航所有电子邮件

response = client.getEmails(50, offset: 50).responseJSON { response in
    print(response)
}

计数电子邮件

统计所有认证的电子邮件

response = client.countEmails().responseJSON { response in
    print(response)
}

获取电子邮件

获取单个电子邮件

client.getEmail("EMAIL_ID").responseJSON { response in
    print(response)
}

创建电子邮件

创建一个新认证的电子邮件。

let file       = NSBundle.mainBundle().URLForResource("Document", withExtension: "pdf")
let recipients = [["email": "[email protected]", "name": "John Doe"]]
let subject    = "Swift subject"
let body       = "Swift body"
let params     = []

client.createEmail([file], recipients: recipients, subject :subject, body: body, params: params, successHandler: { response in
    print(response)
})

获取审计跟踪文档

获取邮件请求的审计跟踪文档。

let path = Alamofire.Request.suggestedDownloadDestination(directory: .DocumentDirectory, domain: .UserDomainMask)

client.downloadEmailAuditTrail("EMAIL_ID", certificateId: "CERTIFICATE_ID", path: path).responseJSON { response in
    print(response)
}