Question

注意：我正在使用“经典”体验，因为新界面无法让模板为未来的签名者设置必填字段。

工作流程：

有一个包含大量字段的模板
使用api：
- 从模板创建信封/文档，并指定一个新用户进行签名（此文档将成为注册服务的协议）
  - 创建新角色
  - 将roleName设置为模板上的假签名者（因为我无法在模板上配置至少一个签名者的字段）
  - 添加textTabs以尝试填充某些字段。
- 检索收件人
- 创建收件人视图，以便我获取要放入iframe的网址

这有点令人讨厌，因为我不关心让第一个签名者不是用户注册该服务。但是，我希望在签名后将文档复制给某人，但是docusign似乎不支持这个（我已经找到了）。

这是用于创建信封的node.js代码（我认为我的API用法出错了）：

function createEnvelopeDefinition(templateId, userData) {
  var envDef = new docusign.EnvelopeDefinition();
  envDef.setEmailSubject('Signup Agreement');
  envDef.setTemplateId(templateId);

  var tRole = new docusign.TemplateRole();
  tRole.setRoleName('RoleOne');
  tRole.setName(userData.fullName);
  tRole.setEmail(userData.email);
  tRole.setClientUserId('2');
  tRole.setTabs(new docusign.Tabs());
  tRole.getTabs().setTextTabs([]);

  const fieldsToPreFill = [
    'field1',
    'field2',
    'field3',
    'field4'];

  fieldsToPreFill.forEach(fieldName => {
    let textTab = new docusign.Text();
    let value = userData[fieldName];
    if (value === null || value === undefined) { value = 'not null'; }
    textTab.setTabLabel(fieldName);
    textTab.setValue(value);
    tRole.getTabs().getTextTabs().push(textTab);
  });

  tRole = removeNulls(tRole);

  envDef.setTemplateRoles([tRole]);

  // send the envelope by setting |status| to 'sent'.
  // To save as a draft set to 'created'
  //   sent is required for getting view URLs
  envDef.setStatus('sent');

  return envDef;
}

在docusign的模板编辑器中，Data Field Tag Properties会将每个相应字段的标签显示为field1，field2等。

当我在iframe中抛出新信封时，这些字段现在用提供的值填充。

这里仅供参考，是创建api连接的其余代码，并获取视图URL

import ENV from 'environment/backend';
const accountId = ENV.docusign.accountId;
var Promise = require('bluebird');

var docusign = require('docusign-esign');

export function newApiClient() {
  let apiClient = new docusign.ApiClient();
  apiClient.setBasePath(ENV.docusign.endpoint);

  // create JSON formatted auth header
  let creds = JSON.stringify({
    Username: ENV.docusign.email,
    Password: ENV.docusign.password,
    IntegratorKey: ENV.docusign.integratorKey
  });

  apiClient.addDefaultHeader('X-DocuSign-Authentication', creds);

  // assign api client to the Configuration object
  // this probably doesn't need to be set every time...
  docusign.Configuration.default.setDefaultApiClient(apiClient);

  return apiClient;
}

const defaultApiClient = newApiClient();
const envelopesApi = new docusign.EnvelopesApi();

const createEnvelope = Promise.promisify(envelopesApi.createEnvelope, { context: envelopesApi });
const listRecipients = Promise.promisify(envelopesApi.listRecipients, { context: envelopesApi });
const createRecipientView = Promise.promisify(envelopesApi.createRecipientView, { context: envelopesApi });

export default defaultApiClient;

// promise resolves to the view URL, envelopeId for the user.
// returns a recipientView
export function setupDocumentForEmbeddedSigning(templateId, userData) {
  let envDefinition = createEnvelopeDefinition(templateId, userData);

  return createEnvelope(accountId, envDefinition, null)
    .then(envelopeSummary => {
      const envelopeId = envelopeSummary.envelopeId;

      return createViewFromEnvelope(envelopeId);
    });
}

export function createViewFromEnvelope(envelopeId) {
  return getRecipients(envelopeId).then(recipients => {
    // the last signer is the one we added in the
    // createEnvelopeDefinition step
    let signers = recipients.signers;
    let lastSigner = signers[signers.length - 1];

    return createView(envelopeId, lastSigner)
      .then(recipientView => [recipientView.url, envelopeId]);
  });
}

function getRecipients(envelopeId) {
  return listRecipients(accountId, envelopeId);
}

function createView(envelopeId, signerData) {
  var viewRequest = new docusign.RecipientViewRequest();
  viewRequest.setReturnUrl(ENV.host);
  viewRequest.setAuthenticationMethod('email');

  // recipient information must match embedded recipient info
  // from the createEnvelopeDefinition method
  viewRequest.setEmail(signerData.email);
  viewRequest.setUserName(signerData.name);
  viewRequest.setRecipientId('2');
  viewRequest.setClientUserId('2');

  return createRecipientView(accountId, envelopeId, viewRequest);
}

// bug with the api wrapper
// https://github.com/docusign/docusign-node-client/issues/47
const removeNulls = function(obj) {
  var isArray = obj instanceof Array;
  for (var k in obj) {
    if (obj[k] === null) isArray ? obj.splice(k, 1) : delete obj[k];
    else if (typeof obj[k] == 'object') removeNulls(obj[k]);
    if (isArray && obj.length == k) removeNulls(obj);
  }
  return obj;
};

Answer 1

所以，我可能不完全明白你被困在哪里，但我还是会对此表示反对...

假设我使用DocuSign UI创建模板并定义两个收件人角色：

签名者1 （将是注册您服务的人） - 行动 =＆＃34;签署＆＃34;
CarbonCopy1 （一旦 Signer1 签名，将会获得已完成/已签名文档的副本） - 行动 =＆＃34;收到副本＆＃34;

（注意：这些角色可以命名为任何你想要的名字 - 我将它们命名为＃34; Signer1＆＃34;以及＆＃34; CarbonCopy1＆＃34;所以它清楚每个角色是谁表示。）

假设上述情况，您的模板的收件人角色（在DocuSign UI中）将如下所示：

接下来，我们假设您在模板的文档中定义了一些字段（标签）（即使用DocuSign UI） Signer1 收件人将需要在签署文档时填充。对于此示例，我们假设其中一个文本标签的标签（名称）为 field1 。请注意，该字段已分配给 Signer1 收件人：

现在，如果我想通过使用此模板的API创建一个Envelope，并为一个或多个收件人预填字段，那么这样做的关键是使用＆＃34;复合模板＆＃34; API请求中的结构。（有关详细信息，请参阅this page的复合模板部分。）在上述示例中，API请求中的 compositeTemplates 对象将包含一个 serverTemplate 对象（指定 templateId 和序列 = 1）和一个 inlineTemplate 对象（指定序列） = 2和收件人信息，包括您要预填的任何标签（字段）的值。

在上面描述的示例中，创建信封的JSON API请求看起来像这样（假设我们只是为 Signer1预填充单个字段 - 显然你可以预先 - 只需将其包含在请求的标签对象中以及 field1 ，即可填写其他字段：

POST https://{{env}}.docusign.net/restapi//v2/accounts/{{accountId}}/envelopes

{
    "emailSubject": "Test Pre-fill Tabs",
    "emailBlurb": "This is a test.",
    "compositeTemplates": [{
        "serverTemplates": [{
            "sequence": "1",
            "templateId": "CD0E6D53-3447-4A9E-BBAF-0EB2C78E8310"
        }],
        "inlineTemplates":[{
            "sequence": "2",
            "recipients": {
                "signers": [
                    {
                        "roleName": "Signer1",
                        "recipientId": "1",
                        "name": "John Doe",
                        "email": "johndoe@test.com",
                        "clientUserId": "1234",
                        "tabs": {
                            "textTabs": [
                                {
                                    "tabLabel": "field1",
                                    "value": "TEST-123"
                                }
                            ]
                        }
                    },
                    {
                      "roleName": "CarbonCopy1",
                      "recipientId": "2",
                      "name": "Jane Doe",
                      "email": "janedoe@test.com"
                    }
                ]
            }
        }]
    }],
    "status": "sent"
}

使用上述请求创建信封后，执行＆＃34; POST收件人视图＆＃34;请求获取第一个收件人（https://{{env}}.docusign.net/restapi//v2/accounts/{{accountId}}/envelopes/{{envelopeId/views/recipient）的签名URL。

然后，当我随后使用该响应中返回的网址启动 Signer1 （John Doe）的签名会话时，我看到 field1 tab确实预填充了我在＆＃34;创建信封＆＃34;中指定的值。 API请求（ TEST-123 ）：

此外，一旦John Doe（ Signer1 ）完成签名并提交已完成的文件，Jane Doe（ CarbonCopy1 ）将会收到一份副本。

我不熟悉DocuSign Node SDK，但想象一下您可以找出使用复合模板的语法，如上例所示。希望这有帮助！

如何使用Docusign的REST API预先填充从模板创建的信封中的字段？

1 个答案: