docusignapi - 如何在 DocuSign 中加载带有信封 ID 的嵌入式签名请求？

Question

我有模拟账户设置的 API。到目前为止，我已经能够创建我的演示联系人收到的签名请求。我想使用 API 的嵌入式签名部分来加载信封的收件人 View ，但我得到了这两个响应之一(如下所示)。

我有信封 ID，我知道(唯一)收件人的电子邮件和用户名，我可以在沙盒 UI 中看到此信息。

我的请求具有用于创建信封的相同 JSON 授权 key 字符串。

这是我发送的两个示例有效负载(X 替换敏感信息):

要求:

POST /restapi/v2/accounts/110XXXX/envelopes/7dee22f3-90e6-44b0-be6b-XXXXXXX/views/recipient HTTP/1.1
X-DocuSign-Authentication: {"Username":"a312a32d-df78-423e-b916-XXXXXXXXX","Password":"XXXXXX","IntegratorKey":"CONN-18a3c56f-f776-40db-8e33-XXXXXXXXX"}
Accept: application/json
Content-Type: application/json
Cookie: BIGipDocuSign=!aI+3n7V3fB0xBxEb7loYjpEeRwCxTKC4na93ET3RH8aETpEeGTqTaKaY1y6ui+nhmrX85Xa90CfKgfk=
Host: demo.docusign.net
Connection: close
Content-Length: 186

{
  "authenticationMethod": "email",
  "email": "adam@example.com",
  "returnUrl": "http://lvh.me:3000",
  "userName": "John Smith",
  "clientUserId":"21"
}

回复:

HTTP/1.1 400 Bad Request
Cache-Control: no-cache
Content-Length: 152
Content-Type: application/json; charset=utf-8
X-RateLimit-Reset: 1436846400
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 998
Date: Tue, 14 Jul 2015 03:43:01 GMT
Connection: close
Set-Cookie: BIGipDocuSign=!aI+3n7V3fB0xBxEb7loYjpEeRwCxTKC4na93ET3RH8aETpEeGTqTaKaY1y6ui+nhmrX85Xa90CfKgfk=;secure; path=/
Strict-Transport-Security: max-age=31536000; includeSubDomains

{
  "errorCode": "UNKNOWN_ENVELOPE_RECIPIENT",
  "message": "The recipient you have identified is not a valid recipient of the specified envelope."
}

- - - 或者 - - -

要求:

POST /restapi/v2/accounts/110XXXX/envelopes/7dee22f3-90e6-44b0-be6b-XXXXXXX/views/recipient HTTP/1.1
X-DocuSign-Authentication: {"Username":"a312a32d-df78-423e-b916-XXXXXXXXX","Password":"XXXXXX","IntegratorKey":"CONN-18a3c56f-f776-40db-8e33-XXXXXXXXX"}
Accept: application/json
Content-Type: application/json
Cookie: BIGipDocuSign=!aI+3n7V3fB0xBxEb7loYjpEeRwCxTKC4na93ET3RH8aETpEeGTqTaKaY1y6ui+nhmrX85Xa90CfKgfk=
Host: demo.docusign.net
Connection: close
Content-Length: 158

{ 
  "authenticationMethod": "email",
  "email": "adam@example.com",
  "returnUrl": "http://lvh.me:3000",
  "userName": "John Smith"
}

回复:

HTTP/1.1 400 Bad Request
Cache-Control: no-cache
Content-Length: 140
Content-Type: application/json; charset=utf-8
X-RateLimit-Reset: 1436846400
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 997
Date: Tue, 14 Jul 2015 03:53:06 GMT
Connection: close
Set-Cookie: BIGipDocuSign=!J6eG9xlLFCmIIZgb7loYjpEeRwCxTPgRydEJMtaaTaMNaqpZpXKRTbRGctfwEWaI3Ptas3QeaupEj2o=;secure; path=/
Strict-Transport-Security: max-age=31536000; includeSubDomains

{
  "errorCode": "ACCOUNT_NOT_AUTHORIZED_FOR_ENVELOPE",
  "message": "This account is not authorized to access the requested envelope."
}

Answer 1

我建议关注 Quickstart以及在 DocuSign 开发人员中心找到的文档。快速入门中有一个完整的部分解释了嵌入式签名，还有一个专用于 Embedding functionality 的功能页面。里面有你需要的所有信息。

第 1 步:使用嵌入式收件人创建信封

要将收件人指定为嵌入式(意味着他们不会通过电子邮件而是通过您的应用程序发起请求)，您只需设置收件人的 clientUserId属性设置为非空值 - 您的第一个示例看起来不错，将其设置为 21 .一个典型的包络定义如下:

{
    "documents": [{
        "documentBase64": "<Base64BytesHere>",
        "documentId": "1",
        "name": "Test"
    }],
    "emailSubject": "Testing",
    "recipients": {
        "signers": [{
            "name": "John Doe",         
            "email": "john@email.com",
            "clientUserId": "21",               
            "recipientId": "1"
        }]
    },
    "status": "sent"
}

由于为此收件人设置了 clientUserId，因此在发送请求时他们不会收到电子邮件通知(尽管这是一个帐户设置，您可以根据需要修改以仍然发送电子邮件)。

API 方法: Envelopes: create

第 2 步:请求收件人 View (又名嵌入式签名)

一旦信封与嵌入式收件人一起发送，您只需生成签名 URL。要生成签名 URL，您必须提供与将收件人添加到信封时所提供的完全相同的收件人参数。换句话说，您必须提供完全相同的 userName , email , 和 clientUserId .请注意，名称字段名为 userName在此 API 中，而不仅仅是 name用于创建信封 API。

对此的典型请求如下所示:

{
    "authenticationMethod": "email",
    "userName": "John Doe",
    "email": "john@email.com",              
    "clientUserId": "21",
    "returnUrl": "http://www.google.com"
}

API 方法: EnvelopeViews: createRecipient