如何預先填充使用Docusign的REST API從模板創建的信封中的字段？

Question

注意：我正在使用「經典」體驗，因爲新界面無法爲模板設置未來簽名人所需的字段。

的工作流程：

• 有一堆使用API​​領域

• 的模板：

  • 從模板創建一個信封/文檔，並分配一個新用戶簽署（此文件將成爲註冊服務協議）

    • 創建新角色
    • 集ROLENAME僞造簽名模板
    • 添加textTabs嘗試perfill一些字段（因爲我不能沒有在模板上至少一個簽名者配置字段）。

  • 檢索收件人

  • 創建收件人視圖，使我得到的URL就擺在一個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模板，定義兩個收件人角色：

• Signer1（這將是誰是註冊爲您服務的人） - 行動 =「登錄」
• CarbonCopy1（這將是誰得到完成/簽署的文件的副本跡象，一旦Signer1的人） - 行動 =‘收到一份’

（注：這些角色可以被命名爲任何你想要他們的名字 - 我將它們命名爲「Signer1」和「CarbonCopy1」，所以它會是誰清楚每個角色代表）

假設上面的場景中，你的模板的接受者角色（在的DocuSign UI）看起來就像這樣：

接下來，讓我們假設你定義模板的文件（S）在某些領域（標籤）（即使用DocuSign用戶界面）Signer1收件人在簽署文檔時將需要填充。對於此示例，我們假設這些文本選項卡之一的標籤（名稱）是field1。請注意，該場被分配給Signer1收件人：

現在，如果我想創建通過使用該模板的API的信封，並預填充字段的一個或多個的收件人，這樣做的關鍵是使用API​​請求中的「合成模板」結構。 （見的this page對於細節複合模板部分。）在上述的例子中，您的compositeTemplates對象在API請求將包含單個serverTemplate對象（其指定templateId和序列 = 1 ）和單個inlineTemplate對象（其指定序列 = 2和收件人信息，包括要預填的任何製表符（字段）的值）。

在上述例子中，JSON API請求創建信封看起來像這樣（假設我們只是預填充單場爲Signer1 - 很明顯，你可以通過簡單的預填附加字段它們包括在標籤請求對象一起字段1）：

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" 
} 

一旦我創建使用上述要求的信封，我執行了「POST收件人查看」請求得到簽署網址第一個收件人（https://{{env}}.docusign.net/restapi//v2/accounts/{{accountId}}/envelopes/{{envelopeId/views/recipient）。

然後，當我後來使用在該響應返回的URL啓動簽名會爲Signer1（李四），我看到FIELD1標籤確實是預填，我指定的值在 「創建信封」 API請求（TEST-123）：

此外，一旦李四（Signer1）完成簽署並提交完成的文檔，李四（CarbonCopy1）將被髮送副本。

我不熟悉DocuSign Node SDK，但想象一下，您可以找出使用複合模板的語法，如上例所示。希望這可以幫助！