get document detail

interface address:

  • /api/docs/detail/:id

HTTP request method:

  • GET

request params:

  • id (path): document ID

response code:

  • common response

example:

curl -X GET "$BASE_URL/api/docs/detail/1"

response example：

  • JSON:

    {
  "code": 0,
  "message": "OK",
  "data": { "id": "1", "name": "", "parent_id": 0, "locale": "", "ct": 0 }
}

create document

interface address:

  • /api/docs/create

HTTP request method:

  • POST

request params:

  • parent_id (form, optional): parent folder ID, default 0

response code:

  • common response

example:

curl -X POST "$BASE_URL/api/docs/create" -d "parent_id=0"

response example：

  • JSON:

    {
  "code": 0,
  "message": "文档创建成功",
  "data": { "id": "1", "locale": "", "parent_id": 0, "name": "未命名.docx", "ct": 0 }
}

rename document

interface address:

  • /api/docs/rename

HTTP request method:

  • POST

request params:

  • id (form, required): document ID

  • name (form, required): new name

response code:

  • common response

example:

curl -X POST "$BASE_URL/api/docs/rename" -d "id=1&name=新文档.docx"

response example：

  • JSON:

    {
  "code": 0,
  "message": "OK",
  "data": {}
}

download document

interface address:

  • /api/docs/download

HTTP request method:

  • GET

request params:

  • id (query): document ID

response code:

  • common response

example:

curl -X GET "$BASE_URL/api/docs/download?id=1"

response example：

  • Returns a file stream or redirects to the download address

create document change

interface address:

  • /api/docs/createchange

HTTP request method:

  • POST

request params:

  • id (form, required): document ID

  • Change content, etc. (see the implementation; used for collaborative editing)

response code:

  • common response

example:

curl -X POST "$BASE_URL/api/docs/createchange" -d "id=1"

response example：

  • JSON:

    {
  "code": 0,
  "message": "OK",
  "data": {}
}