DocuSign Embedded API для подписи

Question

Вопрос из двух частей:

Мы пытаемся получить уведомление о том, что Документ готов к подписанию (что нам не совсем понятно, что указано в уведомлении). Мы не хотим делать уведомления по электронной почте; мы хотим отключить их. Мы предполагаем, что информация для встроенной подписи содержится в уведомлении не по электронной почте. Существует ли простой способ отправить push-уведомление в другую программу, в которой говорится, что документ готов к отправке, и, если это так, является ли лучшим способом проследить за уведомлением, чтобы получить подпись API POST и запросить информацию у DocuSign?

В нашем тестировании мы смогли получить встроенный URL-адрес подписи с помощью вызова API, но он переносит нас на страницу с представлением подписи, где вкладки не отображаются; это означает, что подписывающее лицо не может подписывать, также как и для других ролей. Это та же проблема, которая объясняется в этом посте, по большей части. Я пишу на JavaScript, а не на PHP. Я не знаю, изменит ли это ответ на вопрос, если да, пожалуйста, задавайте больше вопросов в комментариях, и я могу предоставить больше информации.

Это то, что мы получаем, но мы должны получить документ с вкладками для подписи

Это то, что мы должны увидеть. Мы видим эту версию при ручном входе в DS и нажатии на документ.

Мы полагаем, что причиной этого может быть поле templateRoleName, но мы протестировали с этим и без него, и, похоже, это не имеет значения.

Это файл JS для вызова API, который мы используем в пошаговых руководствах.

//
// to run this sample
//  1. copy the file in your own directory - say, example.js
//  2. change "***" to appropriate values
//  3. install async and request packages
//     npm install async
//     npm install request
//  4. execute
//     node example.js 
// 

var     async = require("async"),       // async module
    request = require("request"),       // request module
    email = "[e-mail]",              // your account email
    password = "password1",         // your account password
    integratorKey = "DEEZ-010ebc24-01cc-143a-98c3-d9dbf7561cb1",            // your account Integrator Key (found on Preferences -> API page)
    recipientName = "[e-mail]",          // recipient (signer) name
    templateId = "1C504DBA-B03F-4E57-B6BB-FD2ABD15837C",            // provide valid templateId from a template in your account
    templateRoleName = "Signer",        // template role that exists on template referenced above
    baseUrl = "",               // we will retrieve this
    envelopeId = "bc14310c-57c0-4168-91be-1fb71ea24c1c";            // created from step 2

async.waterfall(
    [
        //////////////////////////////////////////////////////////////////////
        // Step 1 - Login (used to retrieve accountId and baseUrl)
        //////////////////////////////////////////////////////////////////////
        function(next) {
            var url = "https://demo.docusign.net/restapi/v2/login_information";
            var body = "";  // no request body for login api call

            // set request url, method, body, and headers
            var options = initializeRequest(url, "GET", body, email, password);

            // send the request...
            request(options, function(err, res, body) {
                if(!parseResponseBody(err, res, body)) {
                    return;
                }
                baseUrl = JSON.parse(body).loginAccounts[0].baseUrl;
                next(null); // call next function
            });
        },

        //////////////////////////////////////////////////////////////////////
        // Step 2 - Send envelope with one Embedded recipient (using clientUserId property)
        //////////////////////////////////////////////////////////////////////
        function(next) {
            var url = baseUrl + "/envelopes";
            var body = JSON.stringify({
                "emailSubject": "DocuSign API call - Embedded Sending Example",
                "templateId": templateId,
                "templateRoles": [{
                    "email": email,
                    "name": recipientName,
                    "roleName": templateRoleName,
                    "clientUserId": "1001"  // user-configurable
                }],
                "status": "sent"
            });

            // set request url, method, body, and headers
            var options = initializeRequest(url, "POST", body, email, password);

            // send the request...
            request(options, function(err, res, body) {
                if(!parseResponseBody(err, res, body)) {
                    return;
                }
                // parse the envelopeId value from the response
                envelopeId = JSON.parse(body).envelopeId;
                next(null); // call next function
            });
        },

        //////////////////////////////////////////////////////////////////////
        // Step 3 - Get the Embedded Signing View (aka the recipient view)
        //////////////////////////////////////////////////////////////////////
        function(next) {
            var url = baseUrl + "/envelopes/" + envelopeId + "/views/recipient";
            var method = "POST";
            var body = JSON.stringify({
                "returnUrl": "http://www.docusign.com/devcenter",
                "authenticationMethod": "email",
                "email": email,
                "userName": recipientName,
                "clientUserId": "1001", // must match clientUserId in step 2!
            });

            // set request url, method, body, and headers
            var options = initializeRequest(url, "POST", body, email, password);

            // send the request...
            request(options, function(err, res, body) {
                if(!parseResponseBody(err, res, body))
                    return;
                else
                    console.log("\nNavigate to the above URL to start the Embedded Signing workflow...");
            });
        }
    ]);

    //***********************************************************************************************
    // --- HELPER FUNCTIONS ---
    //***********************************************************************************************
    function initializeRequest(url, method, body, email, password) {
        var options = {
            "method": method,
            "uri": url,
            "body": body,
            "headers": {}
        };
        addRequestHeaders(options, email, password);
        return options;
    }

    ///////////////////////////////////////////////////////////////////////////////////////////////
    function addRequestHeaders(options, email, password) {
        // JSON formatted authentication header (XML format allowed as well)
        dsAuthHeader = JSON.stringify({
            "Username": email,
            "Password": password,
            "IntegratorKey": integratorKey  // global
        });
        // DocuSign authorization header
        options.headers["X-DocuSign-Authentication"] = dsAuthHeader;
    }

    ///////////////////////////////////////////////////////////////////////////////////////////////
    function parseResponseBody(err, res, body) {
        console.log("\r\nAPI Call Result: \r\n", JSON.parse(body));
        if( res.statusCode != 200 && res.statusCode != 201) { // success statuses
            console.log("Error calling webservice, status is: ", res.statusCode);
            console.log("\r\n", err);
            return false;
        }
        return true;
    }

РЕДАКТИРОВАТЬ Это раздел получателей и маршрутизации из классического представления DocuSign для этого шаблона, так же как и в оригинальной публикации этого вопроса.

Это файл Created_RequestRecipientToken из журнала запросов:

POST https://demo.docusign.net:7802/restapi/v2/accounts/1037192/envelopes/deez83c9-b1fg-46ab-bo0c-e4576d952ac6/views/recipient
Content-Length: 185
Connection: keep-alive
Host: demo.docusign.net
X-DocuSign-Authentication: {"Username":"[e-mail]","Password":"[omitted]","IntegratorKey":"[omitted]"}
X-Forwarded-For: 543.155.155.55

{"returnUrl":"http://www.docusign.com/devcenter","authenticationMethod":"email","email":"[e-mail]","userName":"[e-mail]","clientUserId":"1002"}
201 Created
Content-Type: application/json; charset=utf-8

{
  "url": "https://demo.docusign.net/Signing/startinsession.aspx?t=3c06d2a3-e521-4e52-b669-01e24c81c3bf"
}

Это файл Created_CreateEnvelopeFromTemplateAndForms из журнала запросов:

POST https://demo.docusign.net:7802/restapi/v2/accounts/1037192/envelopes
Content-Length: 272
Connection: keep-alive
Host: demo.docusign.net
X-DocuSign-Authentication: {"Username":"[e-mail]","Password":"[omitted]","IntegratorKey":"[omitted]"}
X-Forwarded-For: 143.115.155.55

{"emailSubject":"DocuSign API call - Embedded Sending Example","templateId":"9AF271E2-D38E-4E61-8083-928A3CCE056C",
"templateRoles":[{"email":"[e-mail]","name":"[e-mail]","roleName":"Signer","clientUserId":"1002"}],
"status":"sent"}
201 Created
Content-Type: application/json; charset=utf-8

{
  "envelopeId": "deez83c9-b1fg-46ab-bo0c-e4576d952ac6",
  "uri": "/envelopes/deez83c9-b1fg-46ab-bo0c-e4576d952ac6",
  "statusDateTime": "2015-07-08T15:56:23.5930000Z",
  "status": "sent"
}

это или это или это не решения этого поста.

Answer 1

Когда вы отправляете запрос на подпись из шаблона, если хотите, чтобы получатель (и) наследовал все ранее созданные вкладки и рабочий процесс, вы должны сопоставить их с ролью. Чтобы соответствовать им, вам нужно использовать roleName свойство, которое устанавливается через templateRoleName пример сценария Node, на который вы ссылаетесь.

Прежде всего, я хочу упомянуть, что на вашем первом снимке экрана, где нет вкладок, получатель все еще может подписать, перетащив любую из вкладок слева на документ. Это называется подписью в свободной форме, и они выбирают, какие вкладки, сколько и где разместить их в документах, если они не соответствуют роли шаблона.

Я вижу в вашем коде, что вы устанавливаете значение роли шаблона в значение Signerэто будет работать только в том случае, если вы назвали свою роль заполнителя (шаблона) в веб-консоли при ее создании. Измените значение имени роли в веб-консоли на Signer и это должно работать.