从 DocuSign eSignature API 上的模板预填充信封中的字段

Question

我正在尝试将数据推送到我在 DocuSign UI 上创建的模板上的选项卡中，我希望能够使用 API 调用用我想要的信息填充这些选项卡。

我目前正在使用邮递员进行测试，我在正文请求中有以下代码，签名API使用的URL是https://demo.docusign.net/restapi/v2.1/accounts/6053c210-xxx-xxx-xxx-bb5d4c55ebb3/envelopes

{
"emailBlurb": "Create an envelope with a templateId",
"emailSubject": "Template",
"compositeTemplates": [
    {
        "serverTemplates": [
            {
                "sequence": "1",
                "templateId": "042ff1ab-2c87-4410-96ac-05c02d13b969"
            }
        ],
        "inlineTemplates": [
            {
                "recipients": {
                    "signers": [
                        {
                            "email": "rodrigoesgmail.com",
                            "name": "Rodrigo Test API",
                            "recipientId": "2",
                            "roleName": "seller",
                            "tabs": {
                                "textTabs": [
                            {
                                "tabLabel": "field1",
                                "value": "TEST-123"
                            }
                        ]
                                
                            }
                        }
                    ]
                },
                "sequence": "2"
            }
        ]
    }
],
"status": "sent"

}

请求通过并返回信封 ID 和 200 代码，这意味着它已被创建，并且我还收到了关于模板中定义的收件人和 API 调用中定义的收件人的电子邮件，但是，我在请求正文上创建的选项卡不会在任何地方的文档上的模板上创建，因此一旦发送，模板上不会填充值为“TEST-123”的选项卡。我收到了这篇 answer 的帖子，但没有成功，是我遗漏了什么还是有人知道如何获得我想做的事情？

Answer 1

您是否正在为模板中的选项卡设置选项卡值？

在这种情况下，您的 JSON 对我来说看起来不错，但需要注意的是您的 API 调用的 tabLabel 属性值必须完全匹配 Data label 值为模板中的选项卡设置。

因此，在 DocuSign 网络应用程序中，您需要检查数据标签字段是否设置为完全相同的 field1。

这是一个live working example，它设置模板中定义的选项卡的值。该示例还将模板中的收件人更改为嵌入式收件人。但这不是重点。

动态添加新标签

您还可以使用复合模板向信封添加全新的标签。您只需要定义选项卡并包括将放置选项卡的文档 ID、页码、x 和 y 值。示例：

"envelopeDefinition": {
    "status": "sent",
    "compositeTemplates": [
      {
        "compositeTemplateId": "1",
        "serverTemplates": [
          {
            "sequence": "1",
            "templateId": "36f7e831-9228-4273-929e-f047c133c08b"
          }
        ],
        "inlineTemplates": [
          {
            "sequence": "1",
            "recipients": {
              "signers": [
                {
                  "clientUserId": "1000",
                  "email": "name@example.com",
                  "name": "Signer Name",
                  "roleName": "signer",
                  "recipientId": "1",
                  "tabs": {
                    "textTabs": [
                      {
                        "tabLabel": "signer_title",
                        "value": "Manager"
                      },
                      {
                        "documentId": "1",
                        "locked": "true",
                        "value": "Added via the API. Office:",
                        "font": "Helvetica",
                        "fontSize": "Size12",
                        "pageNumber": "3",
                        "xPosition": "40",
                        "yPosition": "428"
                      }
                    ],
                    "listTabs": [
                      {
                        "documentId": "1",
                        "font": "Helvetica",
                        "fontSize": "Size12",
                        "locked": "false",
                        "required": "false",
                        "pageNumber": "3",
                        "xPosition": "190",
                        "yPosition": "428",
                        "listItems": [
                          {
                            "text": "San Francisco",
                            "value": "SF"
                          },
                          {
                            "text": "London",
                            "value": "LON"
                          },
                          {
                            "text": "Paris",
                            "value": "PAR"
                          },
                          {
                            "text": "Jerusalem",
                            "value": "JLM"
                          },
                          {
                            "text": "São Paulo",
                            "value": "SP"
                          }
                        ]
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    ]
  }