如何使用REST API在DocuSign中为收件人设置clientUserId？

Question

我正在尝试创建一个RecipientView，以通过应用程序发送到创建的信封的收件人。 使用DocuSign的较新API，这需要一个userName ，该userName由创建需要签名的文档的人输入，一封email （仅是收件人的电子邮件），以及一个clientUserId （由发件人生成的字符串值来验证收件人的身份）嵌入式签名者，以便可以生成RecipientView来主持签名仪式。

DocuSign文档引用了我需要设置clientUserId ，但是除了通过API创建信封时，它没有提及如何执行此操作。 但是，在这种情况下，DocuSign Admin客户端将通过实际Web界面上的模板而不是通过API创建信封。

我生成RecipientView的代码都在这里设置：

$url = "https://demo.docusign.net/restapi/v2/accounts/$account_id/envelopes/$envelope_id/views/recipient";

$body = array("returnUrl" => "http://www.docusign.com/devcenter",
              "authenticationMethod" => "None",
              "email" => "$email",
              "userName" => "$name",
              "recipientId" => "$recipientId",
              "clientUserId" => "1000"
);

$body_string = json_encode($body);

$curl = curl_init($url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
    'Accept: application/json',
    'Content-Type: application/json',
    'Content-Length: '.strlen($body_string),
    "Authorization: Bearer $access_token"
));
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, $body_string);
$json_response = curl_exec($curl);

$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);

if ($status != 201){
    die('Could not connect to end point: '.mysqli_error($conn));
}

$response = json_decode($json_response, true);
$url = $response["url"];

当嵌入式签名者是管理员帐户此代码的工作，但不是当信封被发送到收件人的实际。 此请求之后，DocuSign返回的JSON应该是：

{
    "url": "example.example.com"
}

但是，对于不是DocuSign帐户管理员的收件人，我得到的回报是：

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

我相信不设置clientUserId是造成此问题的原因，因为文档说我需要设置clientUserId ，而不仅仅是在进行调用时创建一个值。 如何通过REST API设置收件人的clientUserId ？

更新：在这种情况下，我将不是创建和发送信封的人。 这将由我通过我的应用程序拥有的客户端完成，其中大多数将很可能使用Web界面而不是API来执行此操作。 我确实有权访问有关每个客户端的Admin帐户的所有信息，包括集成商密钥，访问令牌，信封ID，帐户ID等。

Answer 1

对于嵌入式签名（又称为收件人视图），您需要拨打两个电话。 好吧，实际上有3个调用，包括初始的Login API，但这听起来像您已经完成了工作，所以我将重点介绍其他两个。

步骤＃1 ：创建带有嵌入式收件人的信封。 当添加收件人确保您设置自己的name ， email ， recipientId和clientUserId 。

步骤2 ：为签名者请求信封的收件人视图。 要做到这一点，你需要调用EnvelopeViews：createRecipient API，你必须引用完全相同的设置您在步骤1中设置收件人值（即name ， email ， recipientId和clientUserId ）

查看App API食谱中的“ 签名 ”以获取完整的代码示例。