使用Docusign REST API将文档附加到SignerAttachmentTab

时间:2016-10-28 15:00:08

标签: docusignapi

我们已经定义了一个模板,该模板将由我们的客户填写并签名。在此模板中,我们预先填充了一些字段以及我们将附加的一些文档。客户将填写其他字段并附加更多文档。我们使用REST API生成签名请求。我们能够生成正确的REST请求以填充模板中的选项卡,设置收件人并成功发送签名请求。这一切都很棒。但是现在我们正在尝试将一个文档附加到模板中相应的SignerAttachmentTab中,我们无法让REST接受它。

我们已尝试使用“文档”字段,但这似乎不适用于模板。我们创建了一个复合模板,然后为文档定义了一个文档,为模板本身定义了一个服务器模板,并为一个内联模板定义了我们想要填充的选项卡数据。这会导致生成有关标签页编号不正确的错误。我们尝试了不同的价值观,并查看了所有与将文档附加到模板相关的论坛帖子和文档,但似乎都没有。

对于文档,我们指定要上载的文件,设置文档ID和名称。在服务器模板中,我们指定模板ID。在内联模板中,我们创建收件人,设置其信息,使用数据构建信封选项卡,然后为文档添加SignerAttachmentTab。在此选项卡中,我们将文档ID设置为与Document元素中的文档ID匹配。我们将tabLabel设置为模板本身使用的标签。我们尝试过设置pagenumber,但这并没有改变任何东西。我们想要的只是将文档发送给客户。打开它时,他们可以双击附件字段并查看我们尝试发送的文档。

我正在尝试使用配方资源管理器使用原始REST来实现此功能,并且它会因TAB_PAGENUMBER_IS_NOT_IN_DOCUMENT错误而失败。看起来该文档优先于模板。遗憾的是,除了在服务器和内联模板上设置序列#之外,我无法更改编辑器中模板的顺序。这是使用DocuSign测试系统生成的请求。

{ 
    "compositeTemplates":[{
       "document":   {
           "documentBase64":"<Base64BytesHere>",
           "documentId":"2",
           "name":"Test.pdf"
       },
       "inlineTemplates":[{
           "recipients":{
               "signers":[{
                     "email":"abc@def.org",
                     "name":"Person",
                     "recipientId":"1",
                     "roleName":"Sender 1",
                     "tabs":{
                          "signerAttachmentTabs":[{
                               "documentId":"2",
                               "tabLabel":"MyAttachment"
                          }],
                          "textTabs":[{
                               "tabLabel":"someText",
                               "value":"Value1" }
                          ]}
                 }]},
             "sequence":"2"
         }],
         "serverTemplates":[{
               "sequence":"1",
               "templateId":"guid}]
             }],
         "emailBlurb":"A message",
         "emailSubject":"Test",
         "status":"sent"
}

我查看了论坛中的现有帖子,要么它们不适用于我的案例,要么他们不是试图将文档实际附加到模板,而只是将它们作为文档包含在模板之外。

2 个答案:

答案 0 :(得分:2)

回复:

  

但是现在我们正在尝试将文档附加到模板中的相应SignerAttachmentTab中,我们无法让REST接受它。

您是否尝试使用API​​将文档添加到SignerAttachmentTab?

不支持此功能。只有签名者自己将文档添加到SignerAttachmentTab。 API无法为他们执行此操作。

您是否希望确保签名者在签字仪式中将文件附加(上传)到信封上?您可以使选项卡非可选(必需)。但是,这不会检查附件的内容。

您可以使用网络连接/连接来检查附加的文件,如果没有附加正确的文件,则为签名者生成另一个信封。

答案 1 :(得分:0)

我弄清楚我做错了什么。对于没有附件的模板,我使用的是TemplateRole和EnvelopeTabs。但是对于附件,尝试包含任何文档会导致文档覆盖模板。所以我切换到复合模板与服务器和内联模板的模板和数据。尝试在允许的各个区域中以各种组合添加文档通常会导致请求被发送但没有文档。

最终解决方案是回到最初的TemplateRole方法,但是将信封创建为草稿。在创建草稿信封后,我可以将文档添加到信封中。但不幸的是,发送信封后,您必须重新连接收件人。我想要清理它,否则它现在正在为我工​​作。