1、后台保存接口

       用于集成方后台直接于畅写服务后台交互接口,集成方后台于POST请求方式发送请求到畅写服务后台,请求参数以JSON格式输入,畅写服务于JSON格式响应。请求发送URL:https://www.51jianxie.com/ds-vpath/coauthoring/CommandService.ashx

 

请求参数及说明:

 

参数

描述

类型

备注


设置命令的类型,支持命令如下:

·          drop用于将用户踢出当前文档(用户只可查看不可编辑)

·          forcesave 强制保存当前编辑的文档并且不关闭文档(调用此命令后用户可继续编辑文档,因此文档可能不是最终的版本),此命令会触发集成方实现的保存回调。

·          info 返回文档状态

string

必填


key

文档的唯一标识(即当前编辑或编辑过的文档ID)

string

必填


userdata

用户自定义数据,可用于集成方传递数据到保存回调

string

可选


users

标识用户列表,结合c=drop使用,用于将用户踢出文档编辑

字符串数组

可选


 

响应JSON数据说明:

 

字段

备注


error

错误码如下:

·          无错误

·          无此文档

·          2 回调保存URL不正确

·          3 服务器内部错误

·          4 forceave 命令调用之前文档无修改

·          5 错误的命令

·          6 token 错误

 


key

文档的唯一标识


 

调用示例

1、用于将用户张三、李四踢出key对应编辑的文档,POST 请求 body。

{ "c": "drop", "key": "123123 ", "users": [ "张三",”李四” ]}

畅写响应如下:

{

    "error": 0,

    "key": "123123 "

}

2、触发强制保存回调,POST 请求 body。

{

    "c": "forcesave",

    "key": "123123 ",

    "userdata": "集成方自定义数据"

}

畅写响应如下:

{

    "error": 0,

    "key": "123123"

}