如何通过PandaDoc API实现发送给收件人前的文档预览与编辑
PandaDoc API 发送前预览编辑需求解决方案
你需要的文档发送给收件人前的预览、编辑需求完全可以通过PandaDoc API实现,具体方案如下:
方案一:人工可视化预览/编辑
- 操作前提:调用创建文档接口后保持文档为draft草稿状态,不要提前调用发送接口
- 直接调用你已接入的创建会话接口:
https://api.pandadoc.com/public/v1/documents/{{document_id}}/session,按权限需求传入对应参数即可:- 需编辑权限时,请求体添加
"scope": "document.write",返回的链接可打开可视化编辑页面,支持修改文档内容、调整签名/文本框等控件位置、修改字段值 - 仅需预览权限时,请求体添加
"scope": "document.read",返回的链接即为不可编辑的只读预览页面
- 需编辑权限时,请求体添加
- 完成预览/编辑确认内容无误后,再正常调用发送接口推送文档给收件人即可,原有收件人配置、控件规则都会完整保留
方案二:后端自动化编辑(无需人工介入)
如果不需要人工操作,仅需要在后端批量修改文档内容,可调用字段更新接口:PUT https://api.pandadoc.com/public/v1/documents/{{document_id}}/fields
请求体传入需要修改的字段ID、对应内容/属性即可完成批量更新,处理完成后再调用发送接口即可。
注意事项
- 仅处于draft状态的文档支持编辑,若文档已触发发送变为sent状态,无法再执行编辑操作
- 编辑/预览会话链接的有效期可通过请求体的
lifetime参数自定义,单位为秒,最长可设置30天 - 若需要将编辑/预览页面内嵌到自身业务系统的iframe中,需要先在PandaDoc开发者后台将你的业务域名添加到安全白名单,避免跨域拦截
内容的提问来源于stack exchange,提问作者Nikita Salunke
相关产品推荐
相关产品推荐

