如何通过REST API自定义DocuSign收件人视图：隐藏菜单及加载屏

一、隐藏指定菜单与工具栏项 #

你可以通过品牌配置或API请求参数两种方式实现界面元素的隐藏：

1. 品牌配置（可复用方案）

   • 登录DocuSign控制台，进入品牌管理，创建或编辑目标品牌
   • 在「签署体验」选项卡的「工具栏设置」中，禁用不需要的选项（如下载、打印、更多菜单等）
   • 在API的recipientViewRequest中指定该品牌的brandId：

     {
       "recipientViewRequest": {
         "brandId": "你的品牌ID",
         "returnUrl": "https://你的域名.com/返回路径",
         "authenticationMethod": "email",
         // 其他必填参数
       }
     }
     

2. API请求直接配置（单次生效方案）
   在recipientViewRequest中添加toolBarOptions和navigation字段，精准禁用特定项：

   {
     "recipientViewRequest": {
       "returnUrl": "https://你的域名.com/返回路径",
       "authenticationMethod": "email",
       "toolBarOptions": {
         "showDownload": false,
         "showPrint": false,
         "showSave": false,
         "showMore": false
       },
       "navigation": {
         "showPreviousButton": false,
         "showProgressBar": false
       },
       // 其他必填参数
     }
   }
   

   注意：部分工具栏项仅支持通过品牌配置禁用，需以DocuSign官方参数说明为准。

二、抑制DocuSign默认加载屏 #

结合Focused View和URL参数配置即可实现：

1. 启用Focused View
   在recipientViewRequest中设置focusedView为true：

   {
     "recipientViewRequest": {
       "focusedView": true,
       // 其他参数
     }
   }
   

2. 消除默认加载屏
   获取API返回的签署URL后，拼接disableLoadingScreen=1参数，示例：

   // 假设apiResponse.url是获取到的签署链接
   const customSignUrl = `${apiResponse.url}&disableLoadingScreen=1`;
   

   之后将该URL嵌入iframe时，DocuSign的默认加载屏会被隐藏，你可以在自己的页面中添加自定义加载状态替代。

三、验证与调试 #

• 检查返回的签署URL是否包含你配置的参数
• 在不同浏览器、设备上测试嵌入效果，确认菜单/工具栏已隐藏、加载屏不再显示
• 若部分选项未生效，排查是否品牌配置覆盖了API参数，或该选项是否支持API级自定义

内容的提问来源于stack exchange，提问作者Ifra