用于过程信封的Docu Sign Rest API发送者视图问题
[英]Docu Sign Rest API Sender View Issue for in Process Envelope
问题描述
我们正在尝试使用嵌入式签名在iframe中显示发件人视图。 如果一个信封有2个签名者，并且其中一个签名了该信封，我们想向发送者显示该信封的当前状态。
是否有可用的API向发件人显示信封的当前状态。
2 个解决方案
解决方案1
0 2014-06-13 22:10:02
一旦DocuSign信封正在处理中（意味着该信封已发送且未处于草稿状态），则无法生成发件人视图。 发件人视图用于标记信封，如果已经发送了信封，则不允许再进行标记。
因此，要回答您的问题，不，不可能在已发送的信封上生成发件人视图，只能在那时生成签名 URL，并且只能为设置了clientUserId属性的收件人生成签名URL。
有关嵌入式签名的更多信息，请参见：
https://www.docusign.com/developer-center/explore/features/embedding-docusign
解决方案2
0 已采纳 2014-06-16 13:55:42
根据您添加到答案中的注释，获取信封所有收件人的当前状态的最简单方法是GET Recipients API调用：
GET https://{{env}}.docusign.net/restapi/{{version}}/accounts/{{acctId}}/envelopes/{{envelopeId}}/recipients?include_tabs=false&include_extended=false
响应将包含每种接收者类型的接收者对象数组，并且每个接收者对象都有一个status属性，该属性指示接收者的当前状态。 例如，这是包含2个签名者的信封的响应-第一个签名已完成，第二个签名未完成（状态=已交付）：
{
"signers": [
{
"signInEachLocation": "false",
"name": "Abby Adams",
"email": "abby@outlook.com",
"recipientId": "04cdba57-5383-4917-9081-e9dad16ba8a9",
"recipientIdGuid": "04cdba57-5383-4917-9081-e9dad16ba8a9",
"requireIdLookup": "false",
"userId": "1860fbdc-96ee-4d14-8353-c0213cd2728f",
"routingOrder": "1",
"roleName": "Signer 1",
"status": "completed",
"signedDateTime": "2014-04-24T14:00:10.5800000Z",
"deliveredDateTime": "2014-04-24T13:59:35.2330000Z",
"templateLocked": "false",
"templateRequired": "false"
},
{
"signInEachLocation": "false",
"name": "Adam Smith",
"email": "adam@outlook.com",
"recipientId": "fb3708f5-552f-410e-8029-9abbb5214196",
"recipientIdGuid": "fb3708f5-552f-410e-8029-9abbb5214196",
"requireIdLookup": "false",
"userId": "ecd6f430-5c08-4a4c-876e-ba7ad95f13dc",
"routingOrder": "2",
"status": "delivered",
"deliveredDateTime": "2014-04-24T14:00:28.1930000Z"
}
],
"agents": [],
"editors": [],
"intermediaries": [],
"carbonCopies": [],
"certifiedDeliveries": [],
"inPersonSigners": [],
"recipientCount": "2",
"currentRoutingOrder": "2"
}
如果您需要更详细的审核跟踪信息，则可以使用GET Audit Events API调用：
GET https://{{env}}.docusign.net/restapi/{{version}}/accounts/{{acctId}}/envelopes/{{envelopeId}}/audit_events
对此请求的响应将包含一个auditEvent对象数组。 每个auditEvent对象由单个属性eventFields组成，该属性是名称/值对的数组。
例如，以下响应显示Mary Smith创建了信封并发送了信封，然后John Doe查看了信封并拒绝了信封：
{
"auditEvents": [
{
"eventFields": [
{
"name": "logTime",
"value": "2014-05-23T03:07:52.7741974Z"
},
{
"name": "Source",
"value": "api"
},
{
"name": "UserName",
"value": "Mary Smith"
},
{
"name": "UserId",
"value": "bc266e97-83a6-472c-XXXX-ebad10e4cc6a"
},
{
"name": "Action",
"value": "Registered"
},
{
"name": "Message",
"value": "The envelope was created by Mary Smith"
},
{
"name": "EnvelopeStatus",
"value": "created"
},
{
"name": "ClientIPAddress",
"value": "XX.XX.XX.XXX"
},
{
"name": "Information",
"value": ""
},
{
"name": "GeoLocation",
"value": ""
},
{
"name": "Language",
"value": "english (us)"
}
]
},
{
"eventFields": [
{
"name": "logTime",
"value": "2014-05-23T03:07:53.6321919Z"
},
{
"name": "Source",
"value": "api"
},
{
"name": "UserName",
"value": "Mary Smith"
},
{
"name": "UserId",
"value": "bc266e97-83a6-472c-a25b-ebad10e4cc6a"
},
{
"name": "Action",
"value": "Sent Invitations"
},
{
"name": "Message",
"value": "Mary Smith sent an invitation to John Doe [john@outlook.com]"
},
{
"name": "EnvelopeStatus",
"value": "sent"
},
{
"name": "ClientIPAddress",
"value": "XX.XX.XX.XXX"
},
{
"name": "Information",
"value": "John Doe [john@outlook.com]"
},
{
"name": "GeoLocation",
"value": ""
},
{
"name": "Language",
"value": "english (us)"
}
]
},
{
"eventFields": [
{
"name": "logTime",
"value": "2014-05-23T03:12:17.9412976Z"
},
{
"name": "Source",
"value": "web"
},
{
"name": "UserName",
"value": "John Doe"
},
{
"name": "UserId",
"value": "03c8a856-c0ae-41bf-943d-ac6e92db66a8"
},
{
"name": "Action",
"value": "Viewed"
},
{
"name": "Message",
"value": "John Doe viewed the envelope [documents:(Mutual NDA with anchors.pdf)]"
},
{
"name": "EnvelopeStatus",
"value": "sent"
},
{
"name": "ClientIPAddress",
"value": "XX.XX.XX.XXX"
},
{
"name": "Information",
"value": "John Doe viewed the envelope [documents:(Mutual NDA with anchors.pdf)]"
},
{
"name": "GeoLocation",
"value": ""
},
{
"name": "Language",
"value": "english (us)"
}
]
},
{
"eventFields": [
{
"name": "logTime",
"value": "2014-05-23T03:12:30.3432181Z"
},
{
"name": "Source",
"value": "web"
},
{
"name": "UserName",
"value": "John Doe"
},
{
"name": "UserId",
"value": "03c8a856-c0ae-41bf-943d-ac6e92db66a8"
},
{
"name": "Action",
"value": "Declined"
},
{
"name": "Message",
"value": "John Doe declined the envelope [Reason: I changed my mind.]"
},
{
"name": "EnvelopeStatus",
"value": "declined"
},
{
"name": "ClientIPAddress",
"value": "XX.XX.XX.XXX"
},
{
"name": "Information",
"value": "Reason: I changed my mind."
},
{
"name": "GeoLocation",
"value": ""
},
{
"name": "Language",
"value": "english (us)"
}
]
}
]
}
《 DocuSign REST API指南》（ https://10226ec94e53f4ca538f-0035e62ac0d194a46695a3b225d72cc8.ssl.cf2.rackcdn.com/rest-api-guide-v2.pdf ）包含有关这两个API调用的信息。
-更新-
您可以通过使用“ GET Envelope Documents ” API请求随时（例如，无论签名者/信封状态如何）检索信封的文档：
GET https://{{env}}.docusign.net/restapi/{{version}}/accounts/{{acctId}}/envelopes/{{envelopeId}}/documents/combined
响应将包含一个字节流，该字节流以PDF格式表示信封文档的内容-然后，您的应用程序可以将该字节流简单地写入浏览器以显示文档。 有关此操作的详细信息，请参见《 REST API指南》的第177页。
关于您关于自定义“嵌入式发件人视图”的问题-无法通过API自定义发件人视图-即，“嵌入式发件人”将始终能够执行他们发送后能够做的一切直接通过DocuSign Web控制台。
DocuSign Api-发件人视图和EDIT_LOCK_ENVELOPE_LOCKED
[英]DocuSign Api - Sender View & EDIT_LOCK_ENVELOPE_LOCKED
docusign REST API 用于向处理中的信封发送通知/提醒
[英]docusign REST API for sending Notification / Reminder to in-process envelope
声明:本站的技术帖子网页，遵循CC BY-SA 4.0协议，如果您需要转载，请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.