接口认证
OAuth2
亿方云开放平台使用OAuth2作为接口的授权以及认证方式。亿方云开放平台提供了OAuth2的授权码模式以及密码模式，其中对外开放的只有授权码模式，若需要使用密码模式，请与客服联系。
授权码模式
请求授权页
URL
https://oauth.fangcloud.com/oauth/authorize
HTTP请求方式
GET
URL参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| response_type | string | 必须为code |
| client_id | string | 应用申请时提供的client_id |
| redirect_uri | string | 回调地址，需要和应用申请时填写的回调地址相同 |
| state | string | state参数，由第三方传递，无特殊要求 |
请求类似于：https://oauth.fangcloud.com/oauth/authorize?response_type=code&client_id=xxxxx&redirect_uri=http://xxx.xxx.xxx&state=xxx
返回结果
如果用户未登录，则会跳转到登录页，登录后如果未授权，则会302跳转到授权页，如果用户已经授权，则会302跳转到redirect_uri并且带上授权码和state，类似于http://xxx.xxx.xxx?code=xxx&state=xxx
获得token
URL
https://oauth.fangcloud.com/oauth/token
HTTP请求方式
POST
HTTP Header
该接口使用Basic Auth的方式校验client的信息。具体做法是在header中添加类似于"Authorization: Basic xxxxxxxxx"。其中"xxxxxxxxx"是通过client_id和client_secret算出来的，具体算法为Base64Encode(client_id + ":" + client_secret)
URL参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| grant_type | string | 必须为authorization_code |
| code | string | 授权码，即回调地址接收到的授权码，授权码的有效期为5分钟，用过一次，无论成功还是失败，授权码都会失效 |
| redirect_uri | string | 回调地址，需要和应用申请时填写的回调地址相同 |
请求类似于：https://oauth.fangcloud.com/oauth/token?grant_type=authorization_code&code=xxx&redirect_uri=http://xxx.xxx.xxx
返回示例
{
"access_token": "a2f97704-ab83-4719-aa4c-781be761906c",
"token_type": "bearer",
"refresh_token": "0d667a27-66b5-4a69-8872-2272b9f373ed",
"expires_in": 21586,
"scope": "all"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| access_token | string | 接口访问标识 |
| token_type | string | 目前固定为bearer |
| refresh_token | string | 用来刷新access_token，有效时间为30天 |
| expires_in | int | access_token的有效时间，单位为s |
| scope | string | 目前固定为"all" |
密码模式
密码模式目前不对外开放，如需使用请联系客服。
URL
https://oauth.fangcloud.com/oauth/token
HTTP请求方式
POST
HTTP Header
该接口使用Basic Auth的方式校验client的信息。具体做法是在header中添加类似于"Authorization: Basic xxxxxxxxx"。其中"xxxxxxxxx"是通过client_id和client_secret算出来的，具体算法为Base64Encode(client_id + ":" + client_secret)
URL参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| grant_type | string | 必须为password |
| username | string | 密码模式用户用户名 |
| password | string | 密码模式用户密码 |
请求类似于：https://oauth.fangcloud.com/oauth/token?grant_type=password&username=xxx&password=xxx
返回示例
{
"access_token": "a2f97704-ab83-4719-aa4c-781be761906c",
"token_type": "bearer",
"refresh_token": "0d667a27-66b5-4a69-8872-2272b9f373ed",
"expires_in": 21586,
"scope": "all"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| access_token | string | 接口访问标识 |
| token_type | string | 目前固定为bearer |
| refresh_token | string | 用来刷新access_token，有效时间为30天 |
| expires_in | int | access_token的有效时间，单位为s |
| scope | string | 目前固定为"all" |
JWT模式
jwt模式主要用于企业级的授权，要使用该授权模式需要联系客服。
URL
https://oauth.fangcloud.com/oauth/token
HTTP请求方式
POST
HTTP Header
该接口使用Basic Auth的方式校验client的信息。具体做法是在header中添加类似于"Authorization: Basic xxxxxxxxx"。其中"xxxxxxxxx"是通过client_id和client_secret算出来的，具体算法为Base64Encode(client_id + ":" + client_secret)
URL参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| grant_type | string | 必须为jwt |
| assertion | string | jwt字符串 |
请求类似于：https://oauth.fangcloud.com/oauth/token?grant_type=jwt&assertion= <JWT>
返回示例
{
"access_token": "a2f97704-ab83-4719-aa4c-781be761906c",
"token_type": "bearer",
"refresh_token": "0d667a27-66b5-4a69-8872-2272b9f373ed",
"expires_in": 21586,
"scope": "admin"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| access_token | string | 接口访问标识 |
| token_type | string | 目前固定为bearer |
| refresh_token | string | 用来刷新access_token，有效时间为30天 |
| expires_in | int | access_token的有效时间，单位为s |
| scope | string | 目前固定为"admin" |
如何构造jwt
生成密RSA钥对
可以使用openssl工具生成RSA密钥对
openssl genrsa -out private_key.pem 2048
openssl rsa -in private_key.pem -pubout -out public_key.pem
提交公钥
将上述生成的pubkey_key.pem的文件内容提交给我们，我们会返回一个kid作为该公钥的唯一标识
生成jwt
根据jwt规范，jwt主要由三个部分组成，header、claims和signature，每个部分用base64编码并且相互之间通过分隔符.连接，格式如下
<base64URLencoded header>.<base64URLencoded claims>.<base64URLencoded signature>
header属性
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| alg | string | 用于生成以及校验签名的算法，只支持RS256, RS384和RS512 |
| kid | string | 公钥的唯一标识 |
claims属性
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| yifangyun_sub_type | string | 授权对象类型，只能是enterprise或者user |
| sub | string | 授权对象id。授权对象类型为enterprise，sub为企业id；授权对象类型为user，sub为用户id |
| exp | timestamp | 过期时间戳，不能超过iat(若iat不存在则记请求到达服务器时间)60s |
| iat | timestamp | jwt生成时的时间戳(单位为秒) |
| jti | string | jwt的唯一标识，每个jwt应当都有唯一的jti |
根据上述信息可以生成jwt，可以使用的第三方类库可以参考jwt.io
其他接口
刷新token
注: 刷新token会重置access_token和expires_in，原有的access_token失效，但refresh_token有效时间不变
URL
https://oauth.fangcloud.com/oauth/token
HTTP请求方式
POST
HTTP Header
该接口使用Basic Auth的方式校验client的信息。具体做法是在header中添加类似于"Authorization: Basic xxxxxxxxx"。其中"xxxxxxxxx"是通过client_id和client_secret算出来的，具体算法为Base64Encode(client_id + ":" + client_secret)
URL参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| grant_type | string | 必须为refresh_token |
| refresh_token | string | 即获取到的refresh_token |
请求类似于：https://oauth.fangcloud.com/oauth/token?grant_type=refresh_token&refresh_token=xxx
返回示例
{
"access_token": "a2f97704-ab83-4719-aa4c-781be761906c",
"token_type": "bearer",
"refresh_token": "0d667a27-66b5-4a69-8872-2272b9f373ed",
"expires_in": 21586,
"scope": "all"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| access_token | string | 新的接口访问标识 |
| token_type | string | 目前固定为bearer |
| refresh_token | string | 用来刷新access_token，有效时间为30天 |
| expires_in | int | access_token的有效时间，单位为s |
| scope | string | 目前固定为"all" |
撤销token
注: 撤销token会同时使access_token以及关联的refresh_token失效
URL
https://oauth.fangcloud.com/oauth/token/revoke
HTTP请求方式
POST
HTTP Header
该接口使用Basic Auth的方式校验client的信息。具体做法是在header中添加类似于"Authorization: Basic xxxxxxxxx"。其中"xxxxxxxxx"是通过client_id和client_secret算出来的，具体算法为Base64Encode(client_id + ":" + client_secret)
URL参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| token | string | 必须为access_token |
请求类似于：https://oauth.fangcloud.com/oauth/token/revoke?token=xxx
返回示例
{
"success": true
}
接口调用限制
目前对于开放平台的请求, 我们做了请求的频次限制, 在所有api请求的返回结果中会有三个header表示频次限制相关的信息
| 返回header | 字段类型 | 字段说明 |
|---|---|---|
| X-Rate-Limit-Limit | int | 当前接口请求次数的上限, 固定数值 |
| X-Rate-Limit-Remaining | int | 当前接口允许请求的剩余次数 |
| X-Rate-Limit-Reset | int | 当前接口允许请求的剩余次数恢复到上限所需要的时间(单位为秒) |
当请求超过了频次限制, 返回结果的HTTP Status Code为429, 返回body如下
{
"errors": [
{
"code": "rate_limit",
"msg": "Rate limit exceeded!"
}
],
"request_id": "d3e1088f-28af-495d-b7ee-a9e58e989b76"
}
消息推送
描述
当有新消息产生时，向消息回调地址发送POST请求，将消息内容推送给客户。
HTTP请求方式
请求类型为POST，Content-Type为application/x-www-form-urlencoded
请求字段说明
| 字段名 | 字段类型 | 字段说明 | 其他 |
|---|---|---|---|
| customer_id | string | 亿方云在客户系统里的标识 | 可以用来标记消息消息来源 |
| enterprise_id | int | 企业id | |
| time | int | 时间戳 | |
| receivers | string | 接收人 | 在亿方云的用户ID，可以批量，多个逗号隔开 |
| title | string | 标题 | |
| content | string | 内容 | |
| type | string | 消息类型 | 目前暂不支持订阅消息 |
| web_url | string | web消息详情url | 域名需自己添加，跳转到亿方云的web消息详情页，接收人可查看 |
| h5_url | string | h5消息详情url | 域名需自己添加，跳转到亿方云的h5消息详情页，接收人可查看，现支持评论，分享，协作消息 |
请求返回格式
{
"success":true
}
请求失败
如果请求失败（返回不是200或者json格式错误），会重试3次。
接口列表
通用参数
所有的接口在访问时需要在HTTP header中带上access_token。对于含有请求参数的接口，通常是一些POST、PUT或者DELETE接口，还需要设置Content-Type来指定参数的格式。如果需要访问不同版本的API，就需要在请求路径上指定具体版本，如果需要返回不同格式的response body，那么还需要设置Accept。所有的参数都应该采用utf-8的编码：
Headers：
- Authorization：存放access_token，格式为："Bearer " + access_token。
- Content-Type：指明请求参数的格式。如果是POST，需要指定"application/json"，我们目前不支持其他请求参数的格式，比如xml。如果是其他类型比如GET请求，可以不在header中设置Content-Type。
若接口访问成功，我们会返回json格式的response，并且HTTP的status code为200。response的header里的X-Fangcloud-Version表示此次请求访问的api的版本号。
文件操作
获取文件信息
URL
https://open.fangcloud.com/api/v2/file/{id}/info
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件id |
返回示例
{
"parent": {
"type": "folder",
"id": 0,
"name": "全部文件"
},
"id": 501001519182,
"created_at": 1489050941,
"owned_by": {
"login": "tt@t.com",
"enterprise_id": 1,
"id": 468,
"name": "tt"
},
"size": 15,
"path": [
{
"type": "folder",
"id": 0,
"name": "全部文件"
}
],
"description": "",
"type": "file",
"comments_count": 0,
"modified_at": 1489050941,
"modified_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"name": "test_upload.txt",
"sequence_id": 0,
"sha1": "da7df4605e576d89f12c272d7e0f515c91ecf120",
"extension_category": "text"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| type | long | 固定为"file" |
| id | long | 文件id |
| name | string | 文件名 |
| size | long | 文件大小 |
| created_at | timestamp | 文件创建时间，单位为秒 |
| modified_at | timestamp | 文件修改时间，单位为秒 |
| modified_by | mini_user | 文件修改者简略信息 |
| description | string | 文件描述 |
| path | path_folder列表 | 所有祖先文件夹的简略信息 |
| owned_by | user | 文件所有者 |
| parent | path_folder | 父文件夹简略信息 |
| sequence_id | long | 文件次序号 |
| sha1 | string | 文件sha1 |
| comments_count | long | 评论个数 |
| extension_category | string | 文件扩展名的分类 |
错误码列表
- file_not_found
- file_deleted
- permission_denied
获取回收站中文件信息
URL
https://open.fangcloud.com/api/v2/file/{id}/trash
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件id |
返回示例
{
"deleted_at": 1497513560,
"deleted_by": {
"id": 468,
"name": "tt",
"login": "tt@t.com",
"enterprise_id": 1
},
"parent": {
"type": "folder",
"id": 0,
"name": "全部文件"
},
"id": 501001519182,
"created_at": 1489050941,
"owned_by": {
"login": "tt@t.com",
"enterprise_id": 1,
"id": 468,
"name": "tt"
},
"size": 15,
"path": [
{
"type": "folder",
"id": 0,
"name": "全部文件"
}
],
"description": "",
"type": "file",
"comments_count": 0,
"modified_at": 1489050941,
"modified_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"name": "test_upload.txt",
"sequence_id": 0,
"sha1": "da7df4605e576d89f12c272d7e0f515c91ecf120",
"extension_category": "text"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| type | long | 固定为"file" |
| id | long | 文件id |
| name | string | 文件名 |
| size | long | 文件大小 |
| created_at | timestamp | 文件创建时间，单位为秒 |
| modified_at | timestamp | 文件修改时间，单位为秒 |
| modified_by | mini_user | 文件修改者简略信息 |
| modified_at | timestamp | 文件删除时间，单位为秒 |
| deleted_by | mini_user | 文件删除者 |
| description | string | 文件描述 |
| path | path_folder列表 | 所有祖先文件夹的简略信息 |
| owned_by | user | 文件所有者 |
| parent | path_folder | 父文件夹简略信息 |
| sequence_id | long | 文件次序号 |
| sha1 | string | 文件sha1 |
| comments_count | long | 评论个数 |
| extension_category | string | 文件扩展名的分类 |
错误码列表
- file_not_found
- file_in_trash_not_found
- permission_denied
更新文件信息
URL
https://open.fangcloud.com/api/v2/file/{id}/update
HTTP请求方式
POST
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件id |
POST Body
{
"name": "new name",
"description": "new description"
}
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| name | string | 否 | 文件名，文件名称必须是1到222个字符，并且不能含有/ ? : * \" > < \ |
| description | string | 否 | 文件描述，长度必须小于等于140个字符 |
name 和 description 至少要传一个
返回示例
{
"parent": {
"type": "folder",
"id": 0,
"name": "全部文件"
},
"id": 501001519182,
"created_at": 1489050941,
"owned_by": {
"login": "tt@t.com",
"enterprise_id": 1,
"id": 468,
"name": "tt"
},
"size": 15,
"path": [
{
"type": "folder",
"id": 0,
"name": "全部文件"
}
],
"description": "",
"type": "file",
"comments_count": 0,
"modified_at": 1489050941,
"modified_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"name": "test_upload.txt",
"shared": false,
"sequence_id": 0,
"sha1": "da7df4605e576d89f12c272d7e0f515c91ecf120",
"extension_category": "text"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| type | long | 固定为"file" |
| id | long | 文件id |
| name | string | 文件名 |
| size | long | 文件大小 |
| created_at | timestamp | 文件创建时间，单位为秒 |
| modified_at | timestamp | 文件修改时间，单位为秒 |
| modified_by | mini_user | 文件修改者简略信息 |
| description | string | 文件描述 |
| path | path_folder列表 | 所有祖先文件夹的简略信息 |
| owned_by | user | 文件所有者 |
| parent | path_folder | 父文件夹简略信息 |
| sequence_id | long | 文件次序号 |
| sha1 | string | 文件sha1 |
| comments_count | long | 评论个数 |
| extension_category | string | 文件扩展名的分类 |
错误码列表
- file_not_found
- file_deleted
- permission_denied
- request_data_invalid
- file_name_conflict
- item_description_size_incorrect
删除文件至回收站
不支持批量操作
URL
https://open.fangcloud.com/api/v2/file/{id}/delete
HTTP请求方式
POST
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件id |
返回示例
{
"success": true
}
返回字段说明
无
错误码列表
- file_not_found
- permission_denied
- file_deleted
从回收站删除文件
不支持批量操作
URL
https://open.fangcloud.com/api/v2/file/{id}/delete_from_trash
HTTP请求方式
POST
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件id |
返回示例
{
"success": true
}
返回字段说明
无
错误码列表
- file_not_found
- permission_denied
- file_deleted
从回收站恢复文件
不支持批量操作
URL
https://open.fangcloud.com/api/v2/file/{id}/restore_from_trash
HTTP请求方式
POST
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件id |
返回示例
{
"success": true
}
返回字段说明
无
错误码列表
- file_in_trash_not_found
- folder_parent_deleted
移动文件
URL
https://open.fangcloud.com/api/v2/file/{id}/move
HTTP请求方式
POST
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件id |
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| target_folder_id | long | 是 | 目标文件夹id |
返回示例
{
"success": true
}
返回字段说明
无
错误码列表
- file_not_found
- file_deleted
- permission_denied
- folder_not_found
获取新文件上传地址
URL
https://open.fangcloud.com/api/v2/file/upload
HTTP请求方式
POST
POST Body
{
"parent_id": 1234,
"name": "test.doc",
"upload_type": "api"
}
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| parent_id | long | 是 | 上传至的文件夹id |
| name | string | 是 | 文件名称，文件名称必须是1到222个字符，并且不能含有/ ? : * \" > < \ |
| upload_type | string | 是 | 上传类型，目前固定为api |
| is_covered | boolean | 否 | 为true时重名情况下直接返回上传新版本的预签名链接，默认为false |
返回示例
{
"presign_url": "https://upload.fangcloud.com/upload/9aeda9c9c9ee4edd9199e102989ec43c/76404f20763228f072dacd099ae1622beb05e666082b0f9c0df1ae1aaf3e1422"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| presign_url | string | 上传链接，接下来往该链接上传即可上传文件，上传链接的有效时间为1个小时，且只能被使用一次 |
错误码列表
- item_name_invalid
- item_name_size_incorrect
- folder_not_found
- permission_denied
根据路径获取新文件上传地址
URL
https://open.fangcloud.com/api/v2/file/upload_by_path
HTTP请求方式
POST
POST Body
{
"target_folder_path": "会议/9.17/研发",
"name": "test.doc",
"upload_type": "api"
}
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| target_folder_path | string | 是 | 路径名，以/划分文件夹，根目录在个人文件下，文件夹名称必须是1到222个字符，并且不能含有/ ? : * \" > < |且末尾不能为“.” |
| name | string | 是 | 文件名称，文件名称必须是1到222个字符，并且不能含有/ ? : * \" > < \ |
| upload_type | string | 是 | 上传类型，目前固定为api |
| is_covered | boolean | 否 | 为true时重名情况下直接返回上传新版本的预签名链接，默认为false |
返回示例
{
"presign_url": "https://upload.fangcloud.com/upload/9aeda9c9c9ee4edd9199e102989ec43c/76404f20763228f072dacd099ae1622beb05e666082b0f9c0df1ae1aaf3e1422"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| presign_url | string | 上传链接，接下来往该链接上传即可上传文件，上传链接的有效时间为1个小时，且只能被使用一次 |
错误码列表
- item_name_invalid
- item_name_size_incorrect
- permission_denied
获取文件上传新版本地址
URL
https://open.fangcloud.com/api/v2/file/{id}/new_version
HTTP请求方式
POST
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件id |
POST Body
{
"name": "test.doc",
"remark": "test"
}
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| name | string | 是 | 新版本文件名称，文件名称必须是1到222个字符，并且不能含有\ / ? : * \" > < \ |
| upload_type | string | 是 | 上传类型，目前固定为api |
| remark | string | 否 | 上传新版本的备注。 |
返回示例
{
"presign_url": "https://upload.fangcloud.com/upload/9aeda9c9c9ee4edd9199e102989ec43c/76404f20763228f072dacd099ae1622beb05e666082b0f9c0df1ae1aaf3e1422"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| presign_url | url | 上传链接，接下来往该链接上传即可上传文件，上传链接的有效时间为1个小时，且只能被使用一次 |
错误码列表
- item_name_invalid
- item_name_size_incorrect
- file_not_found
- permission_denied
文件上传
URL
类似于https://upload.fangcloud.com/upload/xxxx/xxxxxx这样的链接
上传方式
拿到上传地址之后，建议通过multipart的方式进行上传
返回示例
{
"parent": {
"type": "folder",
"id": 0,
"name": "全部文件"
},
"id": 501001519182,
"created_at": 1489050941,
"owned_by": {
"login": "tt@t.com",
"enterprise_id": 1,
"id": 468,
"name": "tt"
},
"size": 15,
"path": [
{
"type": "folder",
"id": 0,
"name": "全部文件"
}
],
"description": "",
"type": "file",
"comments_count": 0,
"modified_at": 1489050941,
"modified_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"name": "test_upload.txt",
"sequence_id": 0,
"sha1": "da7df4605e576d89f12c272d7e0f515c91ecf120",
"extension_category": "text"
}
获取文件的下载地址
URL
https://open.fangcloud.com/api/v2/file/{id}/download
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件id |
URL参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| version | int | 否 | 下载版本号 |
| valid_period | int | 否 | 下载链接过期时间（秒） |
返回示例
{
"download_url":"https://download.fangcloud.com/download/cd83d521b38b43bcace629a69f27422d/06b907d00e70d79ad114b7e2142126efa4d808d97e680bb6bbc4bb5924f6ee80/3-%E9%80%9A%E8%AE%AF%E5%BD%95+%284%29.xlsx"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| download_url | string | 下载链接，访问该下载链接即可下载文件，默认下载链接的有效时间为1个小时 |
错误码列表
- file_not_found
- file_deleted
- permission_denied
获取预览token
URL
https://open.fangcloud.com/api/v2/file/preview_token
HTTP请求方式
POST
POST Body
{
"file_id": 123,
"file_version_id": 123,
"period": 7200
}
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| file_id | long | 是 | 文件id |
| file_version_id | long | 否 | 文件版本id |
| period | int | 是 | 预览token过期时间，必须大于300小于7200，单位为s |
返回示例
{
"preview_token": "PkIAzG9FvczsXsGF",
"success": true
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| preview_token | string | 预览token |
错误码列表
- file_not_found
- file_deleted
- file_version_not_found
- permission_denied
预览嵌入
若需要在浏览器中展现预览图，并且不想自己实现预览图的加载，那么可以通过iframe的形式嵌入亿方云提供的预览页面。我们分别为PC浏览器（Web）和移动端浏览器（HTML5）提供了各自的预览页面。
URL
- 默认形式如WEB：https://open.fangcloud.com/preview/preview.html
- HTML5：https://open.fangcloud.com/preview/preview-mobile.html
调用方式
iframe
URL参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| preview_token | string | 是 | 通过获取预览token接口得到的token |
示例
<iframe src="https://open.fangcloud.com/preview/preview.html?preview_token=xxx"></iframe>
复制文件
URL
https://open.fangcloud.com/api/v2/file/{id}/copy
HTTP请求方式
POST
POST Body
{
"target_folder_id": 2
}
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件id |
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| target_folder_id | long | 是 | 拷贝至的文件夹id |
返回示例
{
"parent": {
"type": "folder",
"id": 0,
"name": "全部文件"
},
"id": 501001519182,
"created_at": 1489050941,
"owned_by": {
"login": "tt@t.com",
"enterprise_id": 1,
"id": 468,
"name": "tt"
},
"size": 15,
"path": [
{
"type": "folder",
"id": 0,
"name": "全部文件"
}
],
"description": "",
"type": "file",
"comments_count": 0,
"modified_at": 1489050941,
"modified_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"name": "test_upload.txt",
"sequence_id": 0,
"sha1": "da7df4605e576d89f12c272d7e0f515c91ecf120",
"extension_category": "text"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| type | long | 固定为"file" |
| id | long | 文件id |
| name | string | 文件名 |
| size | long | 文件大小 |
| created_at | timestamp | 文件创建时间，单位为秒 |
| modified_at | timestamp | 文件修改时间，单位为秒 |
| modified_by | mini_user | 文件修改者简略信息 |
| description | string | 文件描述 |
| path | path_folder列表 | 所有祖先文件夹的简略信息 |
| owned_by | user | 文件所有者 |
| parent | path_folder | 父文件夹简略信息 |
| sequence_id | long | 文件次序号 |
| sha1 | string | 文件sha1 |
| comments_count | long | 评论个数 |
| extension_category | string | 文件扩展名的分类 |
错误码列表
- folder_not_found
- folder_deleted
- file_not_found
- file_deleted
- permission_denied
根据路径复制文件
URL
https://open.fangcloud.com/api/v2/file/{id}/copy_by_path
HTTP请求方式
POST
POST Body
{
"target_folder_path": "会议/9.25/研发"
}
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件id |
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| target_folder_path | string | 是 | 路径名，以/划分文件夹，根目录在个人文件下，文件夹名称必须是1到222个字符，并且不能含有/ ? : * \" > < |且末尾不能为“.” |
返回示例
{
"parent": {
"type": "folder",
"id": 0,
"name": "全部文件"
},
"id": 501001519182,
"created_at": 1489050941,
"owned_by": {
"login": "tt@t.com",
"enterprise_id": 1,
"id": 468,
"name": "tt"
},
"size": 15,
"path": [
{
"type": "folder",
"id": 0,
"name": "全部文件"
}
],
"description": "",
"type": "file",
"comments_count": 0,
"modified_at": 1489050941,
"modified_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"name": "test_upload.txt",
"sequence_id": 0,
"sha1": "da7df4605e576d89f12c272d7e0f515c91ecf120",
"extension_category": "text"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| type | long | 固定为"file" |
| id | long | 文件id |
| name | string | 文件名 |
| size | long | 文件大小 |
| created_at | timestamp | 文件创建时间，单位为秒 |
| modified_at | timestamp | 文件修改时间，单位为秒 |
| modified_by | mini_user | 文件修改者简略信息 |
| description | string | 文件描述 |
| path | path_folder列表 | 所有祖先文件夹的简略信息 |
| owned_by | user | 文件所有者 |
| parent | path_folder | 父文件夹简略信息 |
| sequence_id | long | 文件次序号 |
| sha1 | string | 文件sha1 |
| comments_count | long | 评论个数 |
| extension_category | string | 文件扩展名的分类 |
错误码列表
- file_not_found
- file_deleted
获取文件的分享链接列表
URL
https://open.fangcloud.com/api/v2/file/{id}/share_links
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件id |
URL参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| page_id | int | 否(默认为0) | 页码 |
| owner_id | long | 否 | 分享链接创建者id |
返回示例
{
"share_links": [
{
"unique_name": "sdfdsfgdfdfdfdfsdfd",
"share_link": "https://www.fangcloud.net/share/sdfdsfgdfdfdfdfsdfd",
"access": "public",
"password_protected": false,
"created_at": 1489050941,
"modified_at": 1489050941,
"due_time": "2017-03-20",
"disable_download": true,
"download_count_total": 0,
"view_count": 0
},
{
"unique_name": "sdfdsfgdfdfdfdfsdfd",
"share_link": "https://www.fangcloud.net/share/sdfdsfgdfdfdfdfsdfd",
"access": "public",
"password_protected": false,
"created_at": 1489050941,
"modified_at": 1489050941,
"due_time": "2017-03-20",
"disable_download": true,
"download_count_total": 0,
"view_count": 0
},
{
"unique_name": "sdfdsfgdfdfdfdfsdfd",
"share_link": "https://www.fangcloud.net/share/sdfdsfgdfdfdfdfsdfd",
"access": "public",
"password_protected": false,
"created_at": 1489050941,
"modified_at": 1489050941,
"due_time": "2017-03-20",
"disable_download": true,
"download_count_total": 0,
"view_count": 0
},
{
"unique_name": "sdfdsfgdfdfdfdfsdfd",
"share_link": "https://www.fangcloud.net/share/sdfdsfgdfdfdfdfsdfd",
"access": "public",
"password_protected": false,
"created_at": 1489050941,
"modified_at": 1489050941,
"due_time": "2017-03-20",
"disable_download": true,
"download_count_total": 0,
"view_count": 0
},
{
"unique_name": "sdfdsfgdfdfdfdfsdfd",
"share_link": "https://www.fangcloud.net/share/sdfdsfgdfdfdfdfsdfd",
"access": "public",
"password_protected": false,
"created_at": 1489050941,
"modified_at": 1489050941,
"due_time": "2017-03-20",
"disable_download": true,
"download_count_total": 0,
"view_count": 0
},
{
"unique_name": "sdfdsfgdfdfdfdfsdfd",
"share_link": "https://www.fangcloud.net/share/sdfdsfgdfdfdfdfsdfd",
"access": "public",
"password_protected": false,
"created_at": 1489050941,
"modified_at": 1489050941,
"due_time": "2017-03-20",
"disable_download": true,
"download_count_total": 0,
"view_count": 0
}
],
"total_count": 6,
"page_id": 0,
"page_capacity": 25,
"page_count": 1
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| share_links | list | 分享链接列表 |
| total_count | long | 分享链接总数 |
| page_id | int | 页码 |
| page_count | int | 总页数 |
| page_capacity | int | 页容量 |
错误码列表
- permission_denied
- request_data_invalid
- item_not_found_or_deleted
获取文件的评论列表
URL
https://open.fangcloud.com/api/v2/file/{id}/comments
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件id |
返回示例
{
"comments": [
{
"id": 31588,
"content": "hahaha",
"created_at": 1491898926,
"user": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
}
},
{
"id": 31590,
"content": "sss",
"created_at": 1491899281,
"user": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
}
},
{
"id": 31600,
"content": "@[21262:sss]",
"created_at": 1491904103,
"user": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
}
}
]
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| comments | list | 评论列表 |
错误码列表
- permission_denied
- file_not_found
获取文件的所有版本列表
URL
https://open.fangcloud.com/api/v2/file/{id}/versions
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件id |
返回示例
{
"file_versions": [
{
"file_id": 3453452342,
"sha1": "1234dfgfdghsdkfjsweresnfdsf",
"name": "sample.zip",
"size": 22635,
"modified_at": 1496288023,
"modified_by": {
"id": 468,
"name": "tt",
"login": "tt@t.com",
"enterprise_id": 1
},
"current": true,
"remark": "",
"description": ""
},
{
"id": 432546576575667,
"file_id": 3453452342,
"sha1": "1234dfgfdghsdkfjsweresnfdsf",
"name": "IMG_0039.JPG",
"size": 60419,
"modified_at": 1495531908,
"modified_by": {
"id": 468,
"name": "tt",
"login": "tt@t.com",
"enterprise_id": 1
},
"current": false,
"remark": "",
"description": ""
}
]
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| file_versions | list | 文件版本列表 |
错误码列表
- permission_denied
- file_not_found
获取文件的特定版本信息
URL
https://open.fangcloud.com/api/v2/file/{id}/version/{version_id}/info
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件id |
| version_id | long | 文件版本id |
返回示例
{
"id": 501000005381,
"file_id": 501001814516,
"sha1": "c9af13525dff3e6a5770f811f4966a8e2214ef71",
"name": "IMG_0039.JPG",
"size": 60419,
"modified_at": 1495531908,
"modified_by": {
"id": 468,
"name": "tt",
"login": "tt@t.com",
"enterprise_id": 1
},
"current": false,
"remark": "",
"description": ""
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件版本id |
| file_id | long | 文件id |
| sha1 | string | 版本sha1 |
| name | string | 版本名称 |
| size | long | 版本大小 |
| modified_at | timestamp | 修改时间 |
| modified_by | mini_user | 修改者 |
| current | boolean | 是否是现在的版本 |
| remark | string | 版本备注 |
| description | string | 版本描述 |
错误码列表
- permission_denied
- file_not_found
- file_deleted
- file_version_deleted
- file_mismatch_with_version
- file_version_not_found
提升版本为当前版本
URL
https://open.fangcloud.com/api/v2/file/{id}/version/{version_id}/promote
HTTP请求方式
POST
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件id |
| version_id | long | 文件版本id |
返回示例
{
"parent": {
"type": "folder",
"id": 0,
"name": "全部文件"
},
"id": 501001519182,
"created_at": 1489050941,
"owned_by": {
"login": "tt@t.com",
"enterprise_id": 1,
"id": 468,
"name": "tt"
},
"size": 15,
"path": [
{
"type": "folder",
"id": 0,
"name": "全部文件"
}
],
"description": "",
"type": "file",
"comments_count": 0,
"modified_at": 1489050941,
"modified_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"name": "test_upload.txt",
"sequence_id": 0,
"sha1": "da7df4605e576d89f12c272d7e0f515c91ecf120",
"extension_category": "text"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| type | long | 固定为"file" |
| id | long | 文件id |
| name | string | 文件名 |
| size | long | 文件大小 |
| created_at | timestamp | 文件创建时间，单位为秒 |
| modified_at | timestamp | 文件修改时间，单位为秒 |
| modified_by | mini_user | 文件修改者简略信息 |
| description | string | 文件描述 |
| path | path_folder列表 | 所有祖先文件夹的简略信息 |
| owned_by | user | 文件所有者 |
| parent | path_folder | 父文件夹简略信息 |
| sequence_id | long | 文件次序号 |
| sha1 | string | 文件sha1 |
| comments_count | long | 评论个数 |
| extension_category | string | 文件扩展名的分类 |
错误码列表
- permission_denied
- file_not_found
- file_deleted
- file_version_deleted
- file_mismatch_with_version
- file_version_not_found
删除文件版本
URL
https://open.fangcloud.com/api/v2/file/{id}/version/{version_id}/delete
HTTP请求方式
POST
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件id |
| version_id | long | 文件版本id |
返回示例
{
"success":true
}
错误码列表
- permission_denied
- file_not_found
- file_deleted
- file_version_deleted
- file_mismatch_with_version
- file_version_not_found
文件夹操作
文件夹返回的folder_type类型现有3种
| 返回值 | 意义 |
|---|---|
| normal | 普通文件夹 |
| department_main | 部门文件夹 |
| department_common | 部门公共资料库 |
获取文件夹信息
URL
https://open.fangcloud.com/api/v2/folder/{id}/info
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件夹id |
返回示例
{
"folder_type": "normal",
"id": 501000307503,
"path": [
{
"name": "全部文件",
"type": "folder",
"id": 0
}
],
"sequence_id": 0,
"name": "unittest_folder",
"owned_by": {
"name": "tt",
"login": "tt@t.com",
"id": 468,
"enterprise_id": 1
},
"type": "folder",
"created_at": 1489053096,
"size": 0,
"description": "",
"parent": {
"name": "全部文件",
"type": "folder",
"id": 0
},
"modified_at": 1489053096,
"modified_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"item_count": 0
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| type | string | 固定为"folder" |
| id | long | 文件夹id |
| name | string | 文件夹名称 |
| size | long | 文件夹大小 |
| created_at | timestamp | 文件夹创建时间，单位为秒 |
| modified_at | timestamp | 文件夹更新时间，单位为秒 |
| modified_by | mini_user | 文件夹修改者 |
| description | string | 文件夹描述 |
| path | path_folder列表 | 所有祖先文件夹的简略信息 |
| owned_by | mini_user | 文件夹所有者 |
| parent | path_folder | 父文件夹简略信息 |
| sequence_id | long | 文件夹次序号 |
| item_count | int | 包含item的数量 |
| folder_type | string | 文件夹类型 |
错误码列表
- permission_denied
- folder_not_found
- folder_deleted
获取回收站中文件夹信息
URL
https://open.fangcloud.com/api/v2/folder/{id}/trash
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件夹id |
返回示例
{
"deleted_at": 1497513743,
"deleted_by": {
"id": 468,
"name": "tt",
"login": "tt@t.com",
"enterprise_id": 1
},
"folder_type": "normal",
"id": 501000307503,
"path": [
{
"name": "全部文件",
"type": "folder",
"id": 0
}
],
"sequence_id": 0,
"name": "unittest_folder",
"owned_by": {
"name": "tt",
"login": "tt@t.com",
"id": 468,
"enterprise_id": 1
},
"type": "folder",
"created_at": 1489053096,
"size": 0,
"description": "",
"parent": {
"name": "全部文件",
"type": "folder",
"id": 0
},
"modified_at": 1489053096,
"modified_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"item_count": 0
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| type | string | 固定为"folder" |
| id | long | 文件夹id |
| name | string | 文件夹名称 |
| size | long | 文件夹大小 |
| created_at | timestamp | 文件夹创建时间，单位为秒 |
| modified_at | timestamp | 文件夹更新时间，单位为秒 |
| modified_by | mini_user | 文件夹修改者 |
| modified_at | timestamp | 文件夹删除时间，单位为秒 |
| deleted_by | mini_user | 文件夹删除者 |
| description | string | 文件夹描述 |
| path | path_folder列表 | 所有祖先文件夹的简略信息 |
| owned_by | user | 文件夹所有者 |
| parent | path_folder | 父文件夹简略信息 |
| sequence_id | long | 文件夹次序号 |
| item_count | int | 包含item的数量 |
| folder_type | string | 文件夹类型 |
错误码列表
- permission_denied
- folder_not_found
- folder_in_trash_not_found
创建文件夹
URL
https://open.fangcloud.com/api/v2/folder/create
HTTP请求方式
POST
POST Body
{
"name": "xxx",
"parent_id": 0,
"target_space": {
"type": "department",
"id": 111
}
}
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| name | string | 是 | 文件夹名，文件夹名称必须是1到222个字符，并且不能含有/ ? : * \" > < \ |
| parent_id | long | 是 | 父文件夹id |
| target_space:type | string | 否 | 空间类型，分为department和personal，分别表示部门空间和个人空间，当parent_id为0时生效 |
| target_space:id | long | 否 | 如果type为department，此id必须指定为部门id；type为personal时无需提供id |
返回示例
{
"folder_type": "normal",
"id": 501000307503,
"path": [
{
"name": "全部文件",
"type": "folder",
"id": 0
}
],
"sequence_id": 0,
"name": "unittest_folder",
"owned_by": {
"name": "tt",
"login": "tt@t.com",
"id": 468,
"enterprise_id": 1
},
"type": "folder",
"created_at": 1489053096,
"size": 0,
"description": "",
"parent": {
"name": "全部文件",
"type": "folder",
"id": 0
},
"modified_at": 1489053096,
"modified_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"item_count": 0
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| type | string | 固定为"folder" |
| id | long | 文件夹id |
| name | string | 文件夹名称 |
| size | long | 文件夹大小 |
| created_at | timestamp | 文件夹创建时间，单位为秒 |
| modified_at | timestamp | 文件夹更新时间，单位为秒 |
| modified_by | mini_user | 文件夹修改者 |
| description | string | 文件夹描述 |
| path | path_folder列表 | 所有祖先文件夹的简略信息 |
| owned_by | user | 文件夹所有者 |
| parent | path_folder | 父文件夹简略信息 |
| sequence_id | long | 文件夹次序号 |
| item_count | int | 包含item的数量 |
| folder_type | string | 文件夹类型 |
错误码列表
- permission_denied
- folder_name_conflict
- folder_not_found
- item_name_invalid
根据路径创建文件夹
URL
https://open.fangcloud.com/api/v2/folder/create_by_path
HTTP请求方式
POST
POST Body
{
"target_folder_path": "会议测试/9.25/研发",
"department_id":2724761
}
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| target_folder_path | string | 是 | 路径名，以/划分文件夹，根目录在个人文件下，文件夹名称必须是1到222个字符，并且不能含有/ ? : * \" > < |且末尾不能为“.” |
| department_id | long | 否 | 不填则默认在个人文件下 |
返回示例
{
"folder_type": "normal",
"id": 501000307503,
"path": [
{
"name": "全部文件",
"type": "folder",
"id": 0
}
],
"sequence_id": 0,
"name": "unittest_folder",
"owned_by": {
"name": "tt",
"login": "tt@t.com",
"id": 468,
"enterprise_id": 1
},
"type": "folder",
"created_at": 1489053096,
"size": 0,
"description": "",
"parent": {
"name": "全部文件",
"type": "folder",
"id": 0
},
"modified_at": 1489053096,
"modified_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"item_count": 0
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| type | string | 固定为"folder" |
| id | long | 文件夹id |
| name | string | 文件夹名称 |
| size | long | 文件夹大小 |
| created_at | timestamp | 文件夹创建时间，单位为秒 |
| modified_at | timestamp | 文件夹更新时间，单位为秒 |
| description | string | 文件夹描述 |
| path | path_folder列表 | 所有祖先文件夹的简略信息 |
| owned_by | user | 文件夹所有者 |
| parent | path_folder | 父文件夹简略信息 |
| sequence_id | long | 文件夹次序号 |
| item_count | int | 包含item的数量 |
备注
- 文件夹已存在，则返回文件夹信息。
- 文件夹不存在，则创建文件夹并返回文件夹信息。
更新文件夹
URL
https://open.fangcloud.com/api/v2/folder/{id}/update
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件夹id |
HTTP请求方式
POST
POST Body
{
"name": "new name"
}
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| name | string | 是 | 文件夹名，文件夹名称必须是1到222个字符，并且不能含有/ ? : * \" > < \ |
返回示例
{
"folder_type": "normal",
"id": 501000307503,
"path": [
{
"name": "全部文件",
"type": "folder",
"id": 0
}
],
"sequence_id": 0,
"name": "unittest_folder",
"owned_by": {
"name": "tt",
"login": "tt@t.com",
"id": 468,
"enterprise_id": 1
},
"type": "folder",
"created_at": 1489053096,
"size": 0,
"description": "",
"parent": {
"name": "全部文件",
"type": "folder",
"id": 0
},
"modified_at": 1489053096,
"modified_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"item_count": 0
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| type | string | 固定为"folder" |
| id | long | 文件夹id |
| name | string | 文件夹名称 |
| size | long | 文件夹大小 |
| created_at | timestamp | 文件夹创建时间，单位为秒 |
| modified_at | timestamp | 文件夹更新时间，单位为秒 |
| modified_by | mini_user | 文件夹修改者 |
| description | string | 文件夹描述 |
| path | path_folder列表 | 所有祖先文件夹的简略信息 |
| owned_by | user | 文件夹所有者 |
| parent | path_folder | 父文件夹简略信息 |
| sequence_id | long | 文件夹次序号 |
| item_count | int | 包含item的数量 |
| folder_type | string | 文件夹类型 |
错误码列表
- permission_denied
- folder_not_found
- folder_deleted
- folder_name_conflict
- request_data_invalid
删除文件夹至回收站
不支持批量操作
URL
https://open.fangcloud.com/api/v2/folder/{id}/delete
HTTP请求方式
POST
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件夹id |
返回示例
{
"success": true
}
错误码列表
- request_data_invalid
- permission_denied
- folder_not_found
- folder_deleted
从回收站删除文件夹
不支持批量操作
URL
https://open.fangcloud.com/api/v2/folder/{id}/delete_from_trash
HTTP请求方式
POST
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件夹id |
返回示例
{
"success": true
}
错误码列表
- request_data_invalid
- permission_denied
- folder_not_found
- folder_deleted
- folder_in_trash_not_found
- folder_empty_in_trash
从回收站恢复文件夹
不支持批量操作
URL
https://open.fangcloud.com/api/v2/folder/{id}/restore_from_trash
HTTP请求方式
POST
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件夹id |
返回示例
{
"success": true
}
错误码列表
- request_data_invalid
- permission_denied
- folder_empty_in_trash
- folder_not_found
- folder_deleted
- folder_parent_deleted
- exceed_enterprise_space_limit
- exceed_user_space_limit
移动文件夹
不支持批量操作
URL
https://open.fangcloud.com/api/v2/folder/{id}/move
HTTP请求方式
POST
POST Body
{
"target_folder_id": 0,
"target_space": {
"type": "department",
"id": 111
}
}
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件夹id |
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| target_folder_id | long | 是 | 目标文件夹id |
| target_space:type | string | 否 | 空间类型，分为department和personal，分别表示部门空间和个人空间，当target_folder_id为0时生效 |
| target_space:id | long | 否 | 如果type为department，此id必须指定为部门id；type为personal时无需提供id |
返回示例
{
"success": true
}
错误码列表
- permission_denied
- folder_not_found
- folder_deleted
- folder_is_descendant
- move_to_itself
- move_to_subfolder
复制文件夹
不支持批量操作
URL
https://open.fangcloud.com/api/v2/folder/{id}/copy
HTTP请求方式
POST
POST Body
{
"target_folder_id": 0,
"target_space": {
"type": "department",
"id": 111
}
}
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件夹id |
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| target_folder_id | long | 是 | 目标文件夹id |
| target_space:type | string | 否 | 空间类型，分为department和personal，分别表示部门空间和个人空间，当target_folder_id为0时生效 |
| target_space:id | long | 否 | 如果type为department，此id必须指定为部门id；type为personal时无需提供id |
返回示例
{
"folder_type": "normal",
"id": 501000307503,
"path": [
{
"name": "全部文件",
"type": "folder",
"id": 0
}
],
"sequence_id": 0,
"name": "unittest_folder",
"owned_by": {
"name": "tt",
"login": "tt@t.com",
"id": 468,
"enterprise_id": 1
},
"type": "folder",
"created_at": 1489053096,
"size": 0,
"description": "",
"parent": {
"name": "全部文件",
"type": "folder",
"id": 0
},
"modified_at": 1489053096,
"modified_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"item_count": 0
}
错误码列表
- permission_denied
- folder_not_found
- folder_deleted
- folder_is_descendant
- copy_to_itself
- copy_to_subfolder
获取单层子文件和文件夹列表
URL
https://open.fangcloud.com/api/v2/folder/{id}/children
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件夹id |
URL参数
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| folder_id | long | 是 | 文件夹id |
| page_id | int | 否 | 页号（默认0） |
| page_capacity | int | 否 | 页容量（默认20） |
| type | string | 否 | 分为file，folder，all三种，默认为all |
| sort_by | string | 否 | 分为name，date，size三种，默认为date |
| sort_direction | string | 否 | 分为desc，asc两种，默认为desc |
返回示例
{
"files": [
{
"comments_count": 0,
"extension_category": "text",
"type": "file",
"id": 501001499710,
"name": "alipay.py",
"size": 1260,
"created_at": 1488770996,
"modified_at": 1489648205,
"modified_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"description": "sss",
"path": [
{
"type": "folder",
"id": 0,
"name": "全部文件"
}
],
"owned_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"parent": {
"type": "folder",
"id": 0,
"name": "全部文件"
},
"sequence_id": 4
}
],
"folders": [
{
"item_count": 0,
"folder_type": "normal",
"type": "folder",
"id": 501000308197,
"name": "111",
"size": 0,
"created_at": 1489570098,
"modified_at": 1489570098,
"modified_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"description": "",
"path": [
{
"type": "folder",
"id": 0,
"name": "全部文件"
}
],
"owned_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"parent": {
"type": "folder",
"id": 0,
"name": "全部文件"
},
"sequence_id": 1
},
{
"item_count": 1,
"folder_type": "normal",
"type": "folder",
"id": 501000309234,
"name": " ss",
"size": 20920,
"created_at": 1490002011,
"modified_at": 1490009935,
"modified_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"description": "",
"path": [
{
"type": "folder",
"id": 0,
"name": "全部文件"
}
],
"owned_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"parent": {
"type": "folder",
"id": 0,
"name": "全部文件"
},
"sequence_id": 3
}
],
"total_count": 6,
"page_id": 0,
"page_capacity": 20,
"page_count": 1
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| folders | list | 包含的folder的list |
| files | list | 包含的file的list |
| total_count | long | 所有item的数量 |
| page_id | int | 页号 |
| page_capacity | int | 页容量 |
| page_count | int | 总页数 |
获取部门首层文件夹列表
URL
https://open.fangcloud.com/api/v2/folder/department_folders
HTTP请求方式
GET
URL参数
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| department_id | long | 是 | 部门id |
| page_id | int | 否 | 页号（默认0） |
| page_capacity | int | 否 | 页容量（默认20） |
| sort_by | string | 否 | 分为name，date，size三种，默认为date |
| sort_direction | string | 否 | 分为desc，asc两种，默认为desc |
返回示例
{
"folders": [
{
"item_count": 0,
"folder_type": "normal",
"type": "folder",
"id": 181000025840,
"name": "new_name_1006",
"size": 0,
"created_at": 1504721335,
"modified_at": 1504721335,
"modified_by": {
"id": 881525,
"name": "xxx",
"login": "xxx@xxx.com",
"enterprise_id": 12401
},
"description": "",
"owned_by": {
"id": 881525,
"name": "xxx",
"login": "xxx@xxx.com",
"enterprise_id": 12401
},
"sequence_id": 0
}
],
"total_count": 1,
"page_id": 0,
"page_capacity": 20,
"page_count": 1
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| folders | list | 包含的folder的list |
| total_count | long | 所有item的数量 |
| page_id | int | 页号 |
| page_capacity | int | 页容量 |
| page_count | int | 总页数 |
错误码列表
- permission_denied
获取个人首层文件夹与文件列表
URL
https://open.fangcloud.com/api/v2/folder/personal_items
HTTP请求方式
GET
URL参数
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| page_id | int | 否 | 页号（默认0） |
| page_capacity | int | 否 | 页容量（默认20） |
| type | string | 否 | 分为file，folder，all三种，默认为all |
| sort_by | string | 否 | 分为name，date，size三种，默认为date |
| sort_direction | string | 否 | 分为desc，asc两种，默认为desc |
返回示例
{
"folders": [
{
"item_count": 0,
"folder_type": "normal",
"type": "folder",
"id": 181000025840,
"name": "new_name_1006",
"size": 0,
"created_at": 1504721335,
"modified_at": 1504721335,
"modified_by": {
"id": 881525,
"name": "xxx",
"login": "xxx@xxx.com",
"enterprise_id": 12401
},
"description": "",
"owned_by": {
"id": 881525,
"name": "xxx",
"login": "xxx@xxx.com",
"enterprise_id": 12401
},
"sequence_id": 0
}
],
"total_count": 1,
"page_id": 0,
"page_capacity": 20,
"page_count": 1
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| folders | list | 包含的folder的list |
| files | list | 包含的file的list |
| total_count | long | 所有item的数量 |
| page_id | int | 页号 |
| page_capacity | int | 页容量 |
| page_count | int | 总页数 |
获取与我协作的文件夹列表
URL
https://open.fangcloud.com/api/v2/folder/collab_folders
HTTP请求方式
GET
URL参数
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| page_id | int | 否 | 页号（默认0） |
| page_capacity | int | 否 | 页容量（默认20） |
返回示例
{
"folders": [
{
"item_count": 0,
"folder_type": "normal",
"type": "folder",
"id": 181000025840,
"name": "new_name_1006",
"size": 0,
"created_at": 1504721335,
"modified_at": 1504721335,
"modified_by": {
"id": 881525,
"name": "xxx",
"login": "xxx@xxx.com",
"enterprise_id": 12401
},
"description": "",
"owned_by": {
"id": 881525,
"name": "xxx",
"login": "xxx@xxx.com",
"enterprise_id": 12401
},
"sequence_id": 0
}
],
"total_count": 1,
"page_id": 0,
"page_capacity": 20,
"page_count": 1
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| folders | list | 包含的folder的list（folder属性中不包含parent和path属性） |
| total_count | long | 所有item的数量 |
| page_id | int | 页号 |
| page_capacity | int | 页容量 |
| page_count | int | 总页数 |
获取文件夹的分享链接列表
URL
https://open.fangcloud.com/api/v2/folder/{id}/share_links
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件夹id |
URL参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| page_id | int | 否(默认为0) | 页码 |
| owner_id | long | 否 | 分享链接创建者id |
返回示例
{
"share_links": [
{
"unique_name": "sdfdsfgdfdfdfdfsdfd",
"share_link": "https://www.fangcloud.net/share/sdfdsfgdfdfdfdfsdfd",
"access": "public",
"password_protected": false,
"created_at": 1489050941,
"modified_at": 1489050941,
"due_time": "2017-03-20",
"disable_download": true,
"download_count_total": 0,
"view_count": 0
},
{
"unique_name": "sdfdsfgdfdfdfdfsdfd",
"share_link": "https://www.fangcloud.net/share/sdfdsfgdfdfdfdfsdfd",
"access": "public",
"password_protected": false,
"created_at": 1489050941,
"modified_at": 1489050941,
"due_time": "2017-03-20",
"disable_download": true,
"download_count_total": 0,
"view_count": 0
},
{
"unique_name": "sdfdsfgdfdfdfdfsdfd",
"share_link": "https://www.fangcloud.net/share/sdfdsfgdfdfdfdfsdfd",
"access": "public",
"password_protected": false,
"created_at": 1489050941,
"modified_at": 1489050941,
"due_time": "2017-03-20",
"disable_download": true,
"download_count_total": 0,
"view_count": 0
},
{
"unique_name": "sdfdsfgdfdfdfdfsdfd",
"share_link": "https://www.fangcloud.net/share/sdfdsfgdfdfdfdfsdfd",
"access": "public",
"password_protected": false,
"created_at": 1489050941,
"modified_at": 1489050941,
"due_time": "2017-03-20",
"disable_download": true,
"download_count_total": 0,
"view_count": 0
},
{
"unique_name": "sdfdsfgdfdfdfdfsdfd",
"share_link": "https://www.fangcloud.net/share/sdfdsfgdfdfdfdfsdfd",
"access": "public",
"password_protected": false,
"created_at": 1489050941,
"modified_at": 1489050941,
"due_time": "2017-03-20",
"disable_download": true,
"download_count_total": 0,
"view_count": 0
},
{
"unique_name": "sdfdsfgdfdfdfdfsdfd",
"share_link": "https://www.fangcloud.net/share/sdfdsfgdfdfdfdfsdfd",
"access": "public",
"password_protected": false,
"created_at": 1489050941,
"modified_at": 1489050941,
"due_time": "2017-03-20",
"disable_download": true,
"download_count_total": 0,
"view_count": 0
}
],
"total_count": 6,
"page_id": 0,
"page_capacity": 25,
"page_count": 1
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| share_links | list | 分享链接列表 |
| total_count | long | 分享链接总数 |
| page_id | int | 页码 |
| page_capacity | int | 页容量 |
| page_count | int | 总页数 |
错误码列表
- permission_denied
- request_data_invalid
- item_not_found_or_deleted
获取文件夹协作信息
URL
https://open.fangcloud.com/api/v2/folder/{id}/collabs
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 文件夹id |
返回示例
{
"final_role": "owner",
"collabs": [
{
"accessible_by": {
"type": "user",
"id": 881525,
"name": "隔壁老王"
},
"accepted": true,
"role": "owner"
},
{
"id": 407030,
"accessible_by": {
"type": "department",
"id": 78385,
"name": "222"
},
"accepted": true,
"role": "editor"
},
{
"id": 407033,
"accessible_by": {
"type": "group",
"id": 94444,
"name": "假发的就是"
},
"accepted": true,
"role": "editor"
},
{
"id": 403889,
"accessible_by": {
"type": "user",
"id": 881526,
"name": "小二上菜"
},
"accepted": true,
"role": "editor"
}
]
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| final_role | string | 当前用户角色 |
| collabs | object | 协作信息 |
| collabs:id | long | 协作id |
| collabs:accessible_by | element | 协作用户/群组/部门信息 |
| collabs:accepted | boolean | 邀请是否被接受 |
| collabs:role | string | 协作的角色 |
错误码列表
- permission_denied
- folder_not_found
- folder_deleted
文件与文件夹操作
搜索
URL
https://open.fangcloud.com/api/v2/item/search
HTTP请求方式
GET
URL参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| query_words | string | 是 | 搜索关键词，不能为空 |
| type | string | 否 | 搜索类型，分为file，folder，all三种，默认为all |
| page_id | int | 否 | 第几页，每页默认20，默认为第0页 |
| search_in_folder | long | 否 | 指定父文件夹，匹配的结果都是该文件夹的子文件或子文件夹 |
| query_filter | string | 否 | 搜索过滤类型，分为file_name，content，creator, all四种，默认为all |
| updated_time_range | string | 否 | 指定更新时间范围搜索 |
注意：updated_time_range参数格式为开始和结束时间戳，并以逗号分隔（如:'1509954358,1509954360'），两个时间戳均可以不传，为空就表示不对开始或结束时间进行限制，但是逗号必须传（如：',1509954360' 或 '1509954358,' 或 ','）
返回示例
{
"files": [
{
"sha1": "1f5243f2ba7872206aef7197ea92762eddf47555",
"comments_count": 0,
"extension_category": "document",
"type": "file",
"id": 3990311,
"name": "新建 Microsoft Word 文档.doc",
"size": 26112,
"created_at": 1461919825,
"modified_at": 1461919826,
"modified_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"description": "",
"path": [
{
"type": "folder",
"id": 0,
"name": "全部文件"
},
{
"type": "folder",
"id": 720342,
"name": "download error"
}
],
"owned_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"parent": {
"type": "folder",
"id": 720342,
"name": "download error"
},
"sequence_id": 1
},
{
"sha1": "1f5243f2ba7872206aef7197ea92762eddf47555",
"comments_count": 0,
"extension_category": "document",
"type": "file",
"id": 3990312,
"name": "新建 Microsoft Word 文档.doc",
"size": 26112,
"created_at": 1461919867,
"modified_at": 1461919868,
"modified_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"description": "",
"path": [
{
"type": "folder",
"id": 0,
"name": "全部文件"
}
],
"owned_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"sequence_id": 0
},
{
"sha1": "21033782df2fa91ba5fe8c86b0d61d5c88b85903",
"comments_count": 0,
"extension_category": "document",
"type": "file",
"id": 3990313,
"name": "qwewq12.ppt",
"size": 102400,
"created_at": 1461919871,
"modified_at": 1462957860,
"modified_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"description": "",
"path": [
{
"type": "folder",
"id": 0,
"name": "全部文件"
}
],
"owned_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"sequence_id": 2
},
{
"sha1": "8cfed9a789a37cc8f195510ca34bd1c2800ea2a6",
"comments_count": 0,
"extension_category": "document",
"type": "file",
"id": 3990314,
"name": "12.xls",
"size": 23040,
"created_at": 1461919873,
"modified_at": 1462783210,
"modified_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"description": "",
"path": [
{
"type": "folder",
"id": 0,
"name": "全部文件"
}
],
"owned_by": {
"id": 468,
"name": "tt2",
"login": "tt@t.com",
"enterprise_id": 1
},
"sequence_id": 3
}
],
"folders": [],
"total_count": 4,
"page_id": 0,
"page_capacity": 20,
"page_count": 1
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| folders | list | 搜索到的folder的list |
| files | list | 搜索到的file的list |
| total_count | long | 所有匹配结果的数量 |
| page_id | int | 页号，从0开始 |
| page_capacity | int | 页容量 |
| page_count | int | 总页数 |
回收站操作
获取回收站中的文件和文件夹列表
URL
https://open.fangcloud.com/api/v2/trash/list
HTTP请求方式
GET
URL参数
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| page_id | int | 否 | 页号（默认0） |
| page_capacity | int | 否 | 页容量（默认20） |
| type | string | 否 | 分为file，folder，all三种，默认为all |
返回示例
{
"files": [
{
"deleted_at": 1497513560,
"deleted_by": {
"id": 468,
"name": "tt",
"login": "tt@t.com",
"enterprise_id": 1
},
"sha1": "9380102d3c4ca63d29b514d7572f6c3b39ea3ef4",
"comments_count": 0,
"extension_category": "document",
"type": "file",
"id": 501001828982,
"name": "周报-20170605.xlsx",
"size": 25535,
"created_at": 1496802544,
"modified_at": 1496976641,
"modified_by": {
"id": 468,
"name": "tt",
"login": "tt@t.com",
"enterprise_id": 1
},
"description": "",
"path": [
{
"type": "folder",
"id": 0,
"name": "全部文件"
},
{
"type": "folder",
"id": 501000413101,
"name": "开放哦平台"
}
],
"owned_by": {
"id": 468,
"name": "tt",
"login": "tt@t.com",
"enterprise_id": 1
},
"parent": {
"type": "folder",
"id": 501000413101,
"name": "开放哦平台"
},
"sequence_id": 4
}
],
"folders": [
{
"deleted_at": 1497513743,
"deleted_by": {
"id": 468,
"name": "tt",
"login": "tt@t.com",
"enterprise_id": 1
},
"item_count": 1,
"folder_type": "normal",
"type": "folder",
"id": 501000416615,
"name": "1112",
"size": 20920,
"created_at": 1496913419,
"modified_at": 1497341325,
"modified_by": {
"id": 468,
"name": "tt",
"login": "tt@t.com",
"enterprise_id": 1
},
"description": "",
"path": [
{
"type": "folder",
"id": 0,
"name": "全部文件"
},
{
"type": "folder",
"id": 501000413101,
"name": "开放哦平台"
}
],
"owned_by": {
"id": 468,
"name": "tt",
"login": "tt@t.com",
"enterprise_id": 1
},
"parent": {
"type": "folder",
"id": 501000413101,
"name": "开放哦平台"
},
"sequence_id": 1
}
],
"total_count": 2,
"page_id": 0,
"page_capacity": 20,
"page_count": 1
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| folders | list | 包含的folder的list |
| files | list | 包含的file的list |
| total_count | long | 所有item的数量 |
| page_id | int | 页号 |
| page_capacity | int | 页容量 |
| page_count | int | 总页数 |
清空回收站
URL
https://open.fangcloud.com/api/v2/trash/clear
HTTP请求方式
POST
POST BODY参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| type | string | 否 | item类型，分为file，folder，all三种，默认为all |
返回示例
{
"success": true
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| backend_processing | boolean | 是否后台处理 |
恢复回收站
URL
https://open.fangcloud.com/api/v2/trash/restore_all
HTTP请求方式
POST
POST BODY参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| type | string | 否 | item类型，分为file，folder，all三种，默认为all |
返回示例
{
"success": true
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| backend_processing | boolean | 是否后台处理 |
错误码列表
分享链接操作
分享权限现有2种
| access字段 | 意义 |
|---|---|
| public | 公开（允许任何人访问） |
| company | 只允许公司成员访问 |
| collaborators | 只允许指定成员或指定群组访问 |
获取分享链接信息
URL
https://open.fangcloud.com/api/v2/share_link/{unique_name}/info
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| unique_name | string | 分享标识符 |
URL参数说明
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| password | string | 密码 |
返回示例
{
"unique_name": "sdfdsfgdfdfdfdfsdfd",
"share_link": "https://www.fangcloud.net/share/sdfdsfgdfdfdfdfsdfd",
"access": "public",
"password_protected": false,
"created_at": 1489050941,
"modified_at": 1489050941,
"due_time": "2017-03-20",
"disable_download": true,
"download_count_total": 0,
"view_count": 0
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| unique_name | string | 分享标识符 |
| share_link | string | 完整分享链接 |
| access | string | 分享链接权限（公开和企业） |
| password_protected | boolean | 是否有密码 |
| created_at | timestamp | 分享链接创建时间 |
| modified_at | timestamp | 分享链接更新时间 |
| due_time | string | 过期时间 |
| disable_download | boolean | 是否禁止下载 |
| download_count_total | long | 总下载次数 |
| view_count | long | 总查看次数 |
错误码列表
- share_link_not_found_or_deleted
- share_link_password_not_provided
- share_link_password_not_correct
- share_link_expired
创建分享链接
企业可以统一指定分享链接不能下载，或者分享范围指定为company。如果这样设置，那么通过此api创建的分享链接也会符合对应的规则（无法下载或无法分享给外部），需要开发者注意返回的具体参数。
URL
https://open.fangcloud.com/api/v2/share_link/create
HTTP请求方式
POST
POST Body
{
"file_id":181000445217,
"access":"collaborators",
"disable_download":true,
"due_time":"2019-03-20",
"group_ids": [323652],
"invited_user_ids": [881526,881525]
}
参数说明
- folder_id 和 file_id 有且只能选择一个
- 当access不为collaborators时，group_ids和invited_user_ids不填
- 当access是collaborators时，group_ids和invited_user_ids至少填一项
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| folder_id | long | 否 | 文件夹id |
| file_id | long | 否 | 文件id |
| access | string | 是 | 权限范围 |
| group_ids | list | 否 | 指定群组id列表和指定部门id列表 |
| invited_user_ids | list | 否 | 指定成员id列表 |
| disable_download | boolean | 否 | 是否不允许下载(默认false) |
| due_time | string | 是 | 到期时间(格式如:2018-10-17) |
| password_protected | boolean | 否 | 是否有密码(默认false) |
| password | string | 否 | 密码 |
返回示例
{
"unique_name": "896f4cf2a9ce02e18d8c8bb57a",
"share_link": "https://www.fangcloud.com/share/896f4cf2a9ce02e18d8c8bb57a",
"access": "collaborators",
"created_at": 1539657255,
"modified_at": 1539657255,
"due_time": "2018-10-17",
"disable_download": true,
"download_count_total": 0,
"view_count": 0
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| unique_name | string | 分享标识符 |
| share_link | string | 完整分享链接 |
| access | string | 分享链接权限（公开、企业或协作者） |
| password_protected | boolean | 是否有密码 |
| created_at | timestamp | 分享链接创建时间 |
| modified_at | timestamp | 分享链接更新时间 |
| due_time | string | 过期时间 |
| disable_download | boolean | 是否禁止下载 |
| download_count_total | long | 总下载次数 |
| view_count | long | 总查看次数 |
错误码列表
- permission_denied
- item_not_found_or_deleted
- share_link_resource_id_not_provided
- share_link_resource_id_ambiguous
- share_link_password_not_provided
- share_link_password_size_incorrect
- share_link_password_invalid
- share_link_access_type_invalid
- due_time_passed
更新分享链接
URL
https://open.fangcloud.com/api/v2/share_link/{unique_name}/update
HTTP请求方式
POST
POST Body
{
"access":"collaborators",
"disable_download":false,
"due_time":"2018-10-19",
"invited_user_ids": [881526,881525]
}
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| unique_name | string | 分享标识符 |
参数说明
- 当access不为collaborators时，group_ids和invited_user_ids不填
- 当access为collaborators时，group_ids和invited_user_ids至少填一项
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| access | string | 是 | 权限范围 |
| group_ids | list | 否 | 指定群组id列表和指定部门id列表 |
| invited_user_ids | list | 否 | 指定成员id列表 |
| disable_download | boolean | 否(默认false) | 是否不允许下载 |
| due_time | string | 是 | 到期时间(格式如:2018-10-20) |
| password_protected | boolean | 否(默认false) | 是否有密码 |
| password | string | 否 | 密码 |
返回示例
{
"unique_name": "896f4cf2a9ce02e18d8c8bb57a",
"share_link": "https://www.fangcloud.com/share/896f4cf2a9ce02e18d8c8bb57a",
"access": "collaborators",
"created_at": 1539657255,
"modified_at": 1539658551,
"due_time": "2018-10-19",
"disable_download": false,
"download_count_total": 2,
"view_count": 7
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| unique_name | string | 分享标识符 |
| share_link | string | 完整分享链接 |
| access | string | 分享链接权限（公开、企业或协作者） |
| password_protected | boolean | 是否有密码 |
| created_at | timestamp | 分享链接创建时间 |
| modified_at | timestamp | 分享链接更新时间 |
| due_time | string | 过期时间 |
| disable_download | boolean | 是否禁止下载 |
| download_count_total | long | 总下载次数 |
| view_count | long | 总查看次数 |
错误码列表
- permission_denied
- share_link_password_not_provided
- share_link_access_type_invalid
- due_time_passed
- share_link_not_found_or_deleted
删除分享链接
URL
https://open.fangcloud.com/api/v2/share_link/{unique_name}/revoke
HTTP请求方式
POST
返回示例
{
"success": true
}
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| unique_name | string | 分享标识符 |
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| success | boolean | 成功标记 |
错误码列表
- share_link_not_found_or_deleted
- permission_denied
协作操作
协作角色现有8种
| 角色字段 | 角色中文名 |
|---|---|
| editor | 编辑者 |
| viewer | 查看者 |
| previewer | 预览者 |
| uploader | 上传者 |
| previewer_uploader | 预览+上传者 |
| coowner | 联合拥有者 |
| viewer_uploader | 查看+上传者 |
| owner | 所有者 |
协作可邀请者共有3种
| 邀请者字段 | 邀请者意义 |
|---|---|
| user | 普通用户 |
| group | 群组 |
| department | 部门 |
owner角色无法邀请和修改
群组和部门无法成为coowner联合拥有者
邀请协作
URL
https://open.fangcloud.com/api/v2/collab/invite
HTTP请求方式
POST
POST Body
{
"folder_id":181000005330,
"accessible_by":{
"type":"group",
"id":94444,
"role":"viewer"
},
"invitation_message":"hello"
}
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| folder_id | long | 是 | 协作文件夹id |
| accessible_by | object | 是 | 邀请对象 |
| accessible_by:type | string | 是 | 邀请对象类型 |
| accessible_by:id | long | 是 | 邀请对象id |
| accessible_by:role | string | 是 | 邀请对象角色 |
| invitation_message | string | 否 | 邀请信息，长度不能超过140个字符 |
返回示例
{
"item": {
"type": "folder",
"id": 181000005330,
"name": "sfss"
},
"id": 412027,
"accessible_by": {
"type": "group",
"id": 94444,
"name": "asdsfd"
},
"accepted": true,
"role": "viewer"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 协作id |
| accessible_by | object | 邀请对象 |
| accessible_by:type | string | 邀请对象类型 |
| accessible_by:id | long | 邀请对象id |
| accessible_by:role | string | 邀请对象角色 |
| item | object | 协作对象 |
| item:type | string | 协作对象类型 |
| item:id | long | 协作对象id |
| item:name | string | 协作对象名称 |
| accepted | boolean | 邀请是否被接受 |
| role | string | 协作的角色 |
错误码列表
- permission_denied
- folder_not_found
- folder_deleted
- collab_invitee_not_in_same_enterprise
- cannot_invite_item_owner
- collab_invitee_has_been_invited
获取协作信息
URL
https://open.fangcloud.com/api/v2/collab/{id}/info
HTTP请求方式
GET
返回示例
{
"item": {
"type": "folder",
"id": 181000005330,
"name": "xxx"
},
"id": 412027,
"accessible_by": {
"type": "group",
"id": 94444,
"name": "xxxzxc"
},
"accepted": true,
"role": "viewer"
}
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 协作id |
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 协作id |
| accessible_by | object | 邀请对象 |
| accessible_by:type | string | 邀请对象类型 |
| accessible_by:id | long | 邀请对象id |
| accessible_by:role | string | 邀请对象角色 |
| item | object | 协作对象 |
| item:type | string | 协作对象类型 |
| item:id | long | 协作对象id |
| item:name | string | 协作对象名称 |
| accepted | boolean | 邀请是否被接受 |
| role | string | 协作的角色 |
错误码列表
- permission_denied
- collab_not_found
- collab_related_folder_deleted
更新协作
URL
https://open.fangcloud.com/api/v2/collab/{id}/update
HTTP请求方式
POST
POST Body
{
"role":"coowner"
}
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 协作id |
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| role | string | 是 | 更新用户角色 |
返回示例
{
"item": {
"type": "folder",
"id": 181000005330,
"name": "xxx"
},
"id": 412027,
"accessible_by": {
"type": "group",
"id": 94444,
"name": "xcxzfsdf"
},
"accepted": true,
"role": "viewer"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 协作id |
| accessible_by | object | 邀请对象 |
| accessible_by:type | string | 邀请对象类型 |
| accessible_by:id | long | 邀请对象id |
| accessible_by:role | string | 邀请对象角色 |
| item | object | 协作对象 |
| item:type | string | 协作对象类型 |
| item:id | long | 协作对象id |
| item:name | string | 协作对象名称 |
| accepted | boolean | 邀请是否被接受 |
| role | string | 协作的角色 |
错误码列表
- permission_denied
- collab_not_found
删除协作
URL
https://open.fangcloud.com/api/v2/collab/{id}/delete
HTTP请求方式
POST
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 协作id |
返回示例
{
"success":true
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| success | boolean | 是否成功 |
错误码列表
- permission_denied
- collab_not_found
评论操作
创建评论
URL
https://open.fangcloud.com/api/v2/comment/create
HTTP请求方式
POST
POST Body
{
"item":501001499710,
"content":"@[21262:sss]"
}
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| file_id | long | 是 | 评论文件id |
| content | string | 是 | 评论文本，长度不能超过1001个字符 |
返回示例
{
"item": {
"type": "file",
"id": 181000113542,
"name": "风光.docx"
},
"id": 43156,
"content": "@[12032111:的]",
"created_at": 1501148332,
"user": {
"id": 881525,
"name": "xdsfd王",
"login": "autov2@test.com",
"enterprise_id": 12401
}
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 评论id |
| created_at | long | 评论创建时间 |
| content | string | 评论文本 |
| item | element | 评论对象信息 |
| user | user | 评论用户 |
错误码列表
- permission_denied
- file_deleted
- file_not_found
- request_data_invalid
删除评论
URL
https://open.fangcloud.com/api/v2/comment/{id}/delete
HTTP请求方式
POST
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 评论id |
返回示例
{
"success":true
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| success | boolean | 是否成功 |
错误码列表
- permission_denied
- comment_not_found
部门操作
获取部门的信息
URL
https://open.fangcloud.com/api/v2/department/{id}/info
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 部门id |
返回示例
{
"created_at": 1496992074,
"children_departments_count": 1,
"director": {
"id": 881525,
"name": "xxx",
"login": "autov2@test.com",
"enterprise_id": 12401
},
"direct_item_count": 1,
"id": 65820,
"name": "xxx",
"user_count": 4,
"parent_id": 0,
"order": 1
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| created_at | long | 部门创建时间 |
| id | long | 部门id |
| name | string | 部门名称 |
| user_count | long | 部门成员数 |
| children_departments_count | long | 部门的子部门个数 |
| director | user | 部门管理者（可能为null） |
| direct_item_count | long | 部门的item个数 |
| parent_id | long | 部门的父部门id |
| order | long | 部门的排序号 |
错误码列表
- permission_denied
- department_not_found
获取部门的子部门列表
URL
https://open.fangcloud.com/api/v2/department/{id}/children
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 部门id， 根部门为0 |
URL参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| permission_filter | boolean | 否(默认false) | 是否过滤权限外的部门 |
返回示例
{
"children": [
{
"id": 69938,
"name": "111",
"user_count": 3,
"children_departments_count": 1,
"direct_item_count": 0,
"order": 1
}
]
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| children | list | 子部门列表 |
| id | long | 子部门id |
| name | string | 子部门名称 |
| user_count | long | 子部门成员数 |
| children_departments_count | long | 子部门的子部门个数 |
| direct_item_count | long | 子部门的item个数 |
| order | long | 子部门的排序号 |
错误码列表
- permission_denied
- department_not_found
获取部门成员列表
URL
https://open.fangcloud.com/api/v2/department/{id}/users
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 部门id |
URL参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| query_words | string | 否 | 部门成员搜索关键字 |
| page_id | int | 否 | 页码 |
返回示例
{
"users": [
{
"id": 881525,
"name": "xxx",
"login": "xxx@xxx.com",
"enterprise_id": 12401
},
{
"id": 881533,
"name": "xxx",
"login": "xxx@xxx.com",
"enterprise_id": 12401
},
{
"id": 881572,
"name": "xxx",
"login": "xxx@xxx.com",
"enterprise_id": 12401
},
{
"id": 881526,
"name": "xxx",
"login": "xxx@xxx.com",
"enterprise_id": 12401
}
],
"total_count": 4,
"page_id": 0,
"page_capacity": 500,
"page_count": 1
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| users | list | 用户信息 |
| total_count | long | 总用户数 |
| page_id | int | 页码 |
| page_capacity | int | 页容量 |
| page_count | int | 总页数 |
错误码列表
- permission_denied
群组操作
获取群组的列表
URL
https://open.fangcloud.com/api/v2/group/list
HTTP请求方式
GET
URL参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| query_words | string | 否 | 查询关键字 |
返回示例
{
"groups": [
{
"id": 94444,
"name": "假发的就是",
"description": "胜多负少的",
"created_at": 1500521310,
"user_count": 2
}
]
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| groups | list | 公司所有群组列表 |
| groups:id | long | 群组id |
| groups:name | string | 群组名称 |
| groups:user_count | long | 群组成员数 |
| groups:description | string | 群组描述 |
| groups:created_at | long | 群组创建时间 |
| groups:admin_user | mini_user | 群组管理员 |
获取群组成员列表
URL
https://open.fangcloud.com/api/v2/group/{id}/users
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 群组id |
URL参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| query_words | string | 否 | 群组成员搜索关键字 |
| page_id | int | 否 | 页码 |
返回示例
{
"users": [
{
"id": 881525,
"name": "xxx",
"login": "xxx@xxx.com",
"enterprise_id": 1
},
{
"id": 881533,
"name": "xxx",
"login": "xxx@xxx.com",
"enterprise_id": 1
},
{
"id": 881572,
"name": "xxx",
"login": "xxx@xxx.com",
"enterprise_id": 1
},
{
"id": 881526,
"name": "xxx",
"login": "xxx@xxx.com",
"enterprise_id": 1
}
],
"total_count": 4,
"page_id": 0,
"page_capacity": 500,
"page_count": 1
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| users | list | 用户信息 |
| total_count | long | 总用户数 |
| page_id | int | 页码 |
| page_capacity | int | 页容量 |
| page_count | int | 总页数 |
错误码列表
- permission_denied
用户操作
获取用户的as_user码
此接口为高级接口，常用于跨用户传输文件，若需使用需联系客服
获取自身用户信息
URL
https://open.fangcloud.com/api/v2/user/info
HTTP请求方式
GET
返回示例
{
"id": 449,
"enterprise": {
"id": 1,
"name": "测试企业",
"admin_user_id": 111
},
"name": "qyang1",
"phone": "15088679770",
"email": "qyang1@admin.com",
"login": "qyang1@admin.com",
"profile_pic_key": "f2b7154b8fa0500004fa0cde46e5e214",
"active": true,
"full_name_pinyin": "qyang1",
"pinyin_first_letters": "qyang1"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 用户id |
| enterprise | object | 企业信息 |
| name | string | 用户姓名 |
| phone | string | 用户手机 |
| string | 用户邮箱 | |
| login | string | 用户登录名（邮箱或手机） |
| profile_pic_key | string | 用户头像下载所需的key |
| active | boolean | 用户是否激活 |
| full_name_pinyin | string | 用户姓名的拼音字母 |
| pinyin_first_letters | string | 用户姓名的拼音首字母 |
获取他人用户信息
只有管理员用户能用此接口获取企业内他人的详细信息，普通用户无法使用，请使用 /usr/search 接口查询用户简要信息
URL
https://open.fangcloud.com/api/v2/user/{id}/info
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 用户id |
返回示例
{
"id": 449,
"enterprise": {
"id": 1,
"name": "测试企业",
"admin_user_id": 111
},
"name": "qyang1",
"phone": "15088679770",
"email": "qyang1@admin.com",
"login": "qyang1@admin.com",
"profile_pic_key": "f2b7154b8fa0500004fa0cde46e5e214",
"active": true,
"full_name_pinyin": "qyang1",
"pinyin_first_letters": "qyang1"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 用户id |
| enterprise | object | 企业信息 |
| name | string | 用户姓名 |
| phone | string | 用户手机 |
| string | 用户邮箱 | |
| login | string | 用户登录名（邮箱或手机） |
| profile_pic_key | string | 用户头像下载所需的key |
| active | boolean | 用户是否激活 |
| full_name_pinyin | string | 用户姓名的拼音字母 |
| pinyin_first_letters | string | 用户姓名的拼音首字母 |
错误码列表
- permission_denied
- user_not_found
下载用户头像
URL
https://open.fangcloud.com/api/v2/user/{id}/profile_pic_download?profile_pic_key={profile_pic_key}
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 用户id |
URL参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| profile_pic_key | string | 是 | 下载头像所需的key |
该接口的返回结果是一个头像文件
错误码列表
- permission_denied
- user_not_found
- user_profile_pic_key_not_found
- user_profile_pic_key_incorrect
- user_profile_pic_not_found
更新用户信息
URL
https://open.fangcloud.com/v2/api/user/update
HTTP请求方式
POST
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| name | string | 是 | 新名字，长度不能超过30个字符 |
返回示例
{
"id": 468,
"enterprise_id": 1,
"name": "tt2",
"phone": "15158110000",
"email": "tt@t.com",
"login": "qyang1@admin.com",
"profile_pic_key": "sadsadsdasdasadasa",
"active": true,
"full_name_pinyin": "tt2",
"pinyin_first_letters": "tt2"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 用户id |
| enterprise_id | long | 企业id |
| name | string | 用户姓名 |
| phone | string | 用户手机 |
| string | 用户邮箱 | |
| login | string | 用户登录名（邮箱或手机） |
| profile_pic_key | string | 用户头像下载所需的key |
| active | boolean | 用户是否激活 |
| full_name_pinyin | string | 用户姓名的拼音字母 |
| pinyin_first_letters | string | 用户姓名的拼音首字母 |
错误码列表
- field_required
- user_name_invalid
获取用户空间使用情况
URL
https://open.fangcloud.com/api/v2/user/space_usage
HTTP请求方式
GET
返回示例
{
"space_used": "110MB",
"space_total": "5GB"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| space_used | long | 已经使用的空间 |
| space_total | long | 总共拥有的空间 |
本企业用户搜索
URL
https://open.fangcloud.com/api/v2/user/search
HTTP请求方式
GET
URL参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| query_words | string | 否(默认企业所有用户) | 查询关键字 |
| page_id | int | 否(默认为0) | 页码 |
返回示例
{
"users": [
{
"id": 1,
"name": "【就】不给你想咋地",
"login": "admin@admin.com",
"enterprise_id": 1
},
{
"id": 34,
"name": "i",
"login": "iss@admin.com",
"enterprise_id": 1
},
{
"id": 35,
"name": "jxx@admin",
"login": "jxx@admin.com",
"enterprise_id": 1
}
],
"total_count": 3,
"page_id": 0,
"page_capacity": 100
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| users | list | 用户信息 |
| total_count | long | 总用户数 |
| page_id | int | 页码 |
| page_capacity | int | 页容量 |
| page_count | int | 总页数 |
获取自身直属部门
URL
https://open.fangcloud.com/api/v2/user/departments
HTTP请求方式
GET
返回示例
{
"departments": [
{
"id": 70419,
"name": "222",
"director": {
"id": 881525,
"name": "隔壁老王",
"login": "autov2@test.com",
"enterprise_id": 12401
},
"user_count": 3,
"children_departments_count": 0,
"direct_item_count": 6
},
{
"id": 69938,
"name": "autotest_Dvk_1516903746",
"director": {
"id": 881525,
"name": "隔壁老王",
"login": "autov2@test.com",
"enterprise_id": 12401
},
"user_count": 4,
"children_departments_count": 2,
"direct_item_count": 23
}
]
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| departments | list | 直属部门列表 |
| id | long | 部门id |
| name | string | 部门名称 |
| director | mini_user | 部门主管 |
| user_count | long | 部门成员数 |
| children_departments_count | long | 部门的子部门个数 |
| direct_item_count | long | 部门的item个数 |
设备操作
设备同步接口的几点说明：
- 文件夹已经同步不代表该文件夹设置了同步标记，同步标记可以设置在个人空间、部门空间和文件夹上
- 设备同步状态指的是用户设置的同步标记信息，而不是所有已经同步的文件夹
- 加入同步时，重复添加已经同步的文件夹或其子文件夹均无效，但是会返回成功不报错
- 移除同步时，移除没有同步标记的文件夹均无效，但是会返回成功不报错
同步类型共三种：department、folder和personal，当同步类型为personal时，id可以任意传，但不可用不传
获取设备同步状态
URL
https://open.fangcloud.com/api/v2/device/{device_token}/synced_status
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| device_token | string | 设备号 |
返回示例
{
"synced_folders": [
{
"sync_root": {
"type": "department",
"id": 1,
"name": "xxx"
},
"id": 181000010188,
"name": "aaa"
}
],
"synced_department_spaces": [
{
"type": "department",
"id": 2,
"name": "xxx2"
}
],
"is_synced_personal_space": false,
"is_synced_collab_space": false
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| synced_folders | list | 同步标记的文件夹信息 |
| synced_folders:sync_root | element | 同步的根信息 |
| synced_department_spaces | list | 同步的部门空间信息 |
| is_synced_personal_space | boolean | 是否同步了个人空间 |
| is_synced_collab_space | boolean | 是否同步了协作空间 |
错误码列表
- invalid_device_token
加入同步
URL
https://open.fangcloud.com/v2/api/device/{device_token}/add_sync
HTTP请求方式
POST
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| device_token | string | 设备号 |
POST Body
{
"target": {
"type": "department",
"id": 1
}
}
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| target | object | 是 | 同步目标信息 |
| target:type | string | 是 | 同步目标类型 |
| target:id | long | 是 | 同步目标id |
返回示例
{
"success": true
}
错误码列表
- invalid_device_token
- folder_deleted
- permission_denied
移除同步
URL
https://open.fangcloud.com/v2/api/device/{device_token}/remove_sync
HTTP请求方式
POST
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| device_token | string | 设备号 |
POST Body
{
"target": {
"type": "department",
"id": 1
}
}
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| target | object | 是 | 同步目标信息 |
| target:type | string | 是 | 同步目标类型 |
| target:id | long | 是 | 同步目标id |
返回示例
{
"success": true
}
错误码列表
- invalid_device_token
- folder_deleted
- permission_denied
企业管理员日志操作
获取日志信息
URL
https://open.fangcloud.com/api/v2/admin/log/log_list
HTTP请求方式
POST
POST Body
{
"start_date":"2018-11-5",
"end_date":"2018-11-5",
"page_id":1,
"page_capacity":2
}
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| start_date | string | 是 | 起始时间，格式为：yyyy-MM-dd, 不得早于今日前90天 |
| end_date | string | 是 | 截止时间，格式为：yyyy-MM-dd, 不得迟于今日 |
| page_id | long | 否 | 页码，默认为1 |
| page_capacity | long | 否 | 页容量，默认为25,不超过500 |
返回示例
{
"user_activities": [
{
"created": 1541405251,
"action_type": {
"name": "预览",
"id": "600"
},
"operator": {
"user_name": "test",
"login": "t@test.com",
"id": "881525"
},
"target": {
"target_file_name": "图片.jpeg",
"size": "69.88KB",
"id": "181000464235"
},
"additional_info": {
"preview_user": {
"id": "1118256",
"name": "test2",
"login": "t2@test.com"
}
},
"platform": {
"service_name": "客户端: WEB",
"ip_address": "IP：115.236.61.114（浙江 杭州）"
}
},
{
"created": 1541402802,
"action_type": {
"name": "预览",
"id": "600"
},
"operator": {
"user_name": "test",
"login": "t@test.com",
"id": "881525"
},
"target": {
"target_file_name": "文档.pdf",
"size": "43.97KB",
"id": "181000464239"
},
"additional_info": {
"info": {
"path": "个人文件/预览文件夹/"
}
},
"platform": {
"service_name": "客户端: WEB",
"ip_address": "IP：115.236.61.114（浙江 杭州）"
}
}
],
"success": true
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| user_activities | list | 用户日志信息 |
| user_activities:created | timestamp | 日志创建时间 |
| user_activities:action_type | map | 操作类型 |
| user_activities:operator | map | 操作者 |
| user_activities:target | map | 操作对象 |
| user_activities:additional_info | map | 附加信息 |
| user_activities:platform | map | 客户端信息 |
| success | boolean | 是否查询成功 |
错误码列表
- permission_denied
- page_id_invalid
- page_capacity_invalid
- log_request_time_out
企业管理员部门操作
获取部门设置信息
URL
https://open.fangcloud.com/api/v2/admin/department/{id}/info
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 部门id |
返回示例
{
"director": {
"id": 881525,
"name": "xxx",
"login": "xxx@test.com"
},
"space_used": 79152336,
"space_total": 21474836480,
"special_users": [],
"hide_phone": false,
"disable_share": false,
"enable_watermark": false,
"collab_auto_accepted": false,
"id": 65820,
"name": "亿方云测试",
"parent_id": 0,
"order": 1
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| director | user | 部门管理员信息 |
| space_used | long | 已用空间，单位为Bytes |
| space_total | long | 总共空间，单位为Bytes |
| special_users | array | 特殊成员信息 |
| hide_phone | boolean | 是否隐藏部门成员手机号 |
| disable_share | boolean | 是否禁用分享 |
| enable_watermark | boolean | 是否开启水印预览 |
| collab_auto_accepted | boolean | 是否自动接受协作邀请 |
| id | long | 部门id |
| name | string | 部门名称 |
| parent_id | long | 部门的父部门id |
| order | long | 部门的排序号 |
错误码列表
- permission_denied
创建部门
URL
https://open.fangcloud.com/api/v2/admin/department/create
HTTP请求方式
POST
POST Body
{
"name": "xxx",
"parent_id":0,
"special_users":[
{
"user_id":111,
"role": "viewer"
}
]
}
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| name | string | 是 | 部门名称，长度不能超过30个字符 |
| parent_id | long | 是 | 父部门id |
| director_id | long | 否 | 部门管理员id |
| special_users | array | 否 | 特殊成员信息 |
| space_total | long | 否 | 总共空间，单位为GB，默认为20 |
| hide_phone | boolean | 否 | 是否隐藏部门成员手机号，默认和上级部门保持一致 |
| disable_share | boolean | 否 | 是否禁用分享，默认和上级部门保持一致 |
| enable_watermark | boolean | 否 | 是否开启水印预览，默认和上级部门保持一致 |
| collab_auto_accepted | boolean | 否 | 是否自动接受协作邀请，默认false |
| create_common_folder | boolean | 否 | 是否建立公共资料库，默认false |
返回示例
{
"director": {
"id": 881525,
"name": "xxx",
"login": "xxx@test.com"
},
"space_used": 79152336,
"space_total": 21474836480,
"special_users": [],
"hide_phone": false,
"disable_share": false,
"enable_watermark": false,
"collab_auto_accepted": false,
"id": 65820,
"name": "亿方云测试",
"parent_id": 0
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| director | user | 部门管理员信息 |
| space_used | long | 已用空间，单位为Bytes |
| space_total | long | 总共空间，单位为Bytes |
| special_users | array | 特殊成员信息 |
| hide_phone | boolean | 是否隐藏部门成员手机号 |
| disable_share | boolean | 是否禁用分享 |
| enable_watermark | boolean | 是否开启水印预览 |
| collab_auto_accepted | boolean | 是否自动接受协作邀请 |
| id | long | 部门id |
| name | string | 部门名称 |
| parent_id | long | 部门的父部门id |
错误码列表
- permission_denied
- department_name_conflict
- user_not_in_enterprise
- department_space_total_exceeds_enterprise_limit
修改部门
URL
https://open.fangcloud.com/api/v2/admin/department/{id}/update
HTTP请求方式
POST
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 部门id |
POST Body
{
"name": "xxx",
"parent_id": 0,
"special_users":[
{
"user_id":111,
"role": "viewer"
}
]
}
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| name | string | 是 | 部门名称，长度不能超过30个字符 |
| parent_id | long | 否 | 父部门id |
| director_id | long | 否 | 部门管理员id |
| special_users | array | 否 | 特殊成员信息 |
| space_total | long | 否 | 总共空间，单位为GB，默认为20 |
| hide_phone | boolean | 否 | 是否隐藏部门成员手机号，默认和上级部门保持一致 |
| disable_share | boolean | 否 | 是否禁用分享，默认和上级部门保持一致 |
| enable_watermark | boolean | 否 | 是否开启水印预览，默认和上级部门保持一致 |
| collab_auto_accepted | boolean | 否 | 是否自动接受协作邀请，默认false |
返回示例
{
"director": {
"id": 881525,
"name": "xxx",
"login": "xxx@test.com"
},
"space_used": 79152336,
"space_total": 21474836480,
"special_users": [],
"hide_phone": false,
"disable_share": false,
"enable_watermark": false,
"collab_auto_accepted": false,
"id": 65820,
"name": "亿方云测试",
"parent_id": 123
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| director | user | 部门管理员信息 |
| space_used | long | 已用空间，单位为Bytes |
| space_total | long | 总共空间，单位为Bytes |
| special_users | array | 特殊成员信息 |
| hide_phone | boolean | 是否隐藏部门成员手机号 |
| disable_share | boolean | 是否禁用分享 |
| enable_watermark | boolean | 是否开启水印预览 |
| collab_auto_accepted | boolean | 是否自动接受协作邀请 |
| id | long | 部门id |
| name | string | 部门名称 |
| parent_id | long | 部门的父部门id |
错误码列表
- permission_denied
- department_name_conflict
- user_not_in_enterprise
- department_space_total_exceeds_enterprise_limit
删除部门
URL
https://open.fangcloud.com/api/v2/admin/department/{id}/delete
HTTP请求方式
POST
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 部门id |
返回示例
{
"success": true
}
错误码列表
- permission_denied
- department_having_children_can_not_delete
添加部门成员
URL
https://open.fangcloud.com/api/v2/admin/department/{id}/add_user
HTTP请求方式
POST
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 部门id |
POST Body
{
"user_id": 111
}
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| user_id | long | 是 | 添加的成员用户id |
返回示例
{
"success": true
}
错误码列表
- permission_denied
- user_already_in_department
- user_not_in_enterprise
- user_exceed_department_limit
移除部门成员
URL
https://open.fangcloud.com/api/v2/admin/department/{id}/remove_user
HTTP请求方式
POST
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 部门id |
POST Body
{
"user_id": 111
}
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| user_id | long | 是 | 移除的成员用户id |
返回示例
{
"success": true
}
错误码列表
- permission_denied
- user_not_in_department
获取部门的子部门列表
URL
https://open.fangcloud.com/api/v2/admin/department/{id}/children
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 部门id， 根部门为0 |
返回示例
{
"children": [
{
"id": 69938,
"name": "111",
"user_count": 3,
"children_departments_count": 1,
"direct_item_count": 0,
"order": 1
}
]
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| children | list | 子部门列表 |
| id | long | 子部门id |
| name | string | 子部门名称 |
| user_count | long | 子部门成员数 |
| children_departments_count | long | 子部门的子部门个数 |
| direct_item_count | long | 子部门的item个数 |
| order | long | 子部门的排序号 |
错误码列表
- permission_denied
- department_not_found
获取部门成员详细列表
URL
https://open.fangcloud.com/api/v2/admin/department/{id}/users
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 部门id |
URL参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| query_words | string | 否 | 部门成员搜索关键字 |
| page_id | int | 否 | 页码 |
返回示例
{
"users": [
{
"user_group": "admin",
"email": "xxx@test.com",
"phone": "12312312312",
"space_total": 2199023255552,
"space_used": 0,
"profile_pic_key": "ee1bacaffb0128a26b51afaf17126a8b",
"is_active": true,
"is_phone_public": true,
"full_name_pinyin": "xxx",
"id": 881525,
"name": "xxx",
"login": "xxx@test.com",
"enterprise_id": 12401
},
{
"user_group": "user",
"email": "xxx@test.com",
"phone": "12312312312",
"space_total": 5368709120,
"space_used": 8745602,
"profile_pic_key": "",
"is_active": true,
"is_phone_public": true,
"full_name_pinyin": "xxx",
"id": 881533,
"name": "xxx",
"login": "xxx@test.com",
"enterprise_id": 12401
},
{
"user_group": "user",
"email": "xxx@test.com",
"phone": "",
"space_total": 2199023255552,
"space_used": 0,
"profile_pic_key": "",
"is_active": true,
"is_phone_public": true,
"full_name_pinyin": "xxx",
"id": 881572,
"name": "xxx",
"login": "xxx@test.com",
"enterprise_id": 12401
},
{
"user_group": "user",
"email": "xxx@test.com",
"phone": "12312312312",
"space_total": 2199023255552,
"space_used": 2869229,
"profile_pic_key": "0cb601c50ed619267bb791cfe2a60ade",
"is_active": true,
"is_phone_public": true,
"full_name_pinyin": "xxx",
"id": 881526,
"name": "xxx",
"login": "autov22@test.com",
"enterprise_id": 12401
}
],
"total_count": 4,
"page_id": 0,
"page_capacity": 500,
"page_count": 1
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| users | list | 详细用户信息 |
| total_count | long | 总用户数 |
| page_id | int | 页码 |
| page_capacity | int | 页容量 |
| page_count | int | 总页数 |
错误码列表
- permission_denied
企业管理员群组操作
获取群组设置信息
URL
https://open.fangcloud.com/api/v2/admin/group/{id}/info
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 群组id |
返回示例
{
"is_visible": true,
"collab_auto_accepted": true,
"id": 157290,
"name": "autotest_Ldm_1513102763",
"description": "",
"created_at": 1513102764,
"user_count": 0
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| collab_auto_accepted | boolean | 是否自动接受协作邀请 |
| is_visible | boolean | 是否可见 |
| id | long | 群组id |
| name | string | 群组名称 |
| description | string | 群组描述 |
| created_at | long | 群组创建时间 |
| user_count | long | 群组成员数 |
错误码列表
- permission_denied
创建群组
URL
https://open.fangcloud.com/api/v2/admin/group/create
HTTP请求方式
POST
POST Body
{
"name": "xxx",
"admin_user_id": 111
}
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| name | string | 是 | 群组名称，长度不能超过30个字符 |
| admin_user_id | long | 否 | 群组管理员id，默认没有 |
| description | string | 否 | 群组描述 |
| visible | boolean | 否 | 是否可见，默认false |
| collab_auto_accepted | boolean | 否 | 是否自动接受协作邀请，默认false，当群组管理员为空时默认为true |
返回示例
{
"is_visible": true,
"collab_auto_accepted": true,
"id": 157290,
"name": "autotest_Ldm_1513102763",
"description": "",
"created_at": 1513102764,
"user_count": 0
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| collab_auto_accepted | boolean | 是否自动接受协作邀请 |
| is_visible | boolean | 是否可见 |
| id | long | 群组id |
| name | string | 群组名称 |
| description | string | 群组描述 |
| created_at | long | 群组创建时间 |
| user_count | long | 群组成员数 |
错误码列表
- permission_denied
- group_name_conflict
- user_not_in_enterprise
修改群组
URL
https://open.fangcloud.com/api/v2/admin/group/{id}/update
HTTP请求方式
POST
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 群组id |
POST Body
{
"name": "xxx"
}
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| name | string | 否 | 群组名称，长度不能超过30个字符 |
| admin_user_id | long | 否 | 群组管理员id，默认没有 |
| description | string | 否 | 群组描述 |
| visible | boolean | 否 | 是否可见，默认false |
| collab_auto_accepted | boolean | 否 | 是否自动接受协作邀请，默认false，当群组管理员为空时默认为true |
返回示例
{
"is_visible": true,
"collab_auto_accepted": true,
"id": 157290,
"name": "autotest_Ldm_1513102763",
"description": "",
"created_at": 1513102764,
"user_count": 0
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| collab_auto_accepted | boolean | 是否自动接受协作邀请 |
| is_visible | boolean | 是否可见 |
| id | long | 群组id |
| name | string | 群组名称 |
| description | string | 群组描述 |
| created_at | long | 群组创建时间 |
| user_count | long | 群组成员数 |
错误码列表
- permission_denied
- group_name_conflict
- user_not_in_enterprise
删除群组
URL
https://open.fangcloud.com/api/v2/admin/group/{id}/delete
HTTP请求方式
POST
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 群组id |
返回示例
{
"success": true
}
错误码列表
- permission_denied
添加群组成员
URL
https://open.fangcloud.com/api/v2/admin/group/{id}/add_user
HTTP请求方式
POST
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 群组id |
POST Body
{
"user_id": 111
}
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| user_id | long | 是 | 添加的成员用户id |
返回示例
{
"success": true
}
错误码列表
- permission_denied
- user_already_in_group
- user_not_in_enterprise
移除群组成员
URL
https://open.fangcloud.com/api/v2/admin/group/{id}/remove_user
HTTP请求方式
POST
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 群组id |
POST Body
{
"user_id": 111
}
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| user_id | long | 是 | 移除的成员用户id |
返回示例
{
"success": true
}
错误码列表
- permission_denied
- user_not_in_group
获取所有群组的列表
URL
https://open.fangcloud.com/api/v2/admin/group/list
HTTP请求方式
GET
URL参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| page_id | long | 否(默认0) | 页号 |
| query_words | string | 否 | 查询关键字 |
返回示例
{
"groups": [
{
"is_visible": true,
"collab_auto_accepted": true,
"id": 157290,
"name": "autotest_Ldm_1513102763",
"description": "",
"created_at": 1513102764,
"user_count": 0
}
],
"total_count": 1,
"page_id": 0,
"page_capacity": 25,
"page_count": 1
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| groups | list | 公司所有群组列表 |
| groups:id | long | 群组id |
| groups:name | string | 群组名称 |
| groups:user_count | long | 群组成员数 |
| groups:description | string | 群组描述 |
| groups:created | long | 群组创建时间 |
| groups:admin_user | mini_user | 群组管理员 |
| groups:collab_auto_accepted | boolean | 是否自动接受协作邀请 |
| groups:is_visiable | boolean | 是否可见 |
| total_count | long | 群组总数 |
| page_id | int | 页号 |
| page_capacity | int | 页容量 |
| page_count | int | 总页数 |
获取群组成员列表
URL
https://open.fangcloud.com/api/v2/admin/group/{id}/users
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 群组id |
URL参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| query_words | string | 否 | 群组成员搜索关键字 |
| page_id | int | 否 | 页码 |
返回示例
{
"users": [
{
"id": 881525,
"name": "xxx",
"login": "xxx@xxx.com",
"enterprise_id": 1
},
{
"id": 881533,
"name": "xxx",
"login": "xxx@xxx.com",
"enterprise_id": 1
},
{
"id": 881572,
"name": "xxx",
"login": "xxx@xxx.com",
"enterprise_id": 1
},
{
"id": 881526,
"name": "xxx",
"login": "xxx@xxx.com",
"enterprise_id": 1
}
],
"total_count": 4,
"page_id": 0,
"page_capacity": 500,
"page_count": 1
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| users | list | 用户信息 |
| total_count | long | 总用户数 |
| page_id | int | 页码 |
| page_capacity | int | 页容量 |
| page_count | int | 总页数 |
错误码列表
- permission_denied
企业管理员用户操作
获取用户设置信息
URL
https://open.fangcloud.com/api/v2/admin/user/{id}/info
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 用户id |
返回示例
{
"hide_phone": false,
"disable_download": false,
"space_used": 14481,
"space_total": 21474836480,
"id": 881525,
"name": "xxx",
"login": "xxx@xxx.com",
"phone": "11111111111",
"email": "xxx@xxx.com",
"profile_pic_key": "ee1bacaffb0128a26b51afaf17126a8b",
"active": true,
"full_name_pinyin": "xxx",
"pinyin_first_letters": "xxx"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| hide_phone | boolean | 是否隐藏手机号 |
| disable_download | boolean | 是否禁用下载 |
| space_used | long | 已用空间，单位为Bytes |
| space_total | long | 总可用空间，单位为Bytes |
| id | long | 用户id |
| name | string | 用户姓名 |
| phone | string | 用户手机 |
| string | 用户邮箱 | |
| login | string | 用户登录名（邮箱或手机） |
| profile_pic_key | string | 用户头像下载所需的key |
| active | boolean | 用户是否激活 |
| full_name_pinyin | string | 用户姓名的拼音字母 |
| pinyin_first_letters | string | 用户姓名的拼音首字母 |
错误码列表
- permission_denied
创建用户
URL
https://open.fangcloud.com/api/v2/admin/user/create
HTTP请求方式
POST
POST Body
{
"phone": "11111111111",
"email": "xxx@xxx.com"
}
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| phone | string | 否 | 用户手机 |
| string | 否 | 用户邮箱 | |
| storage_id | long | 否 | 用户存储id，非多存储不需要关心 |
| space_total | long | 否 | 用户空间大小，-1为无限，单位为GB |
| hide_phone | boolean | 否 | 是否隐藏手机号，默认为false |
| disable_download | boolean | 否 | 是否禁用下载，默认为false |
| force_active | boolean | 否 | 是否强制激活，默认为false |
| password | string | 否 | 当force_active为true时，必须提供并且长度在6-32位之间，false时忽略该参数 |
phone和email必须选择其一，但不能同时提供
返回示例
{
"hide_phone": false,
"disable_download": false,
"space_used": 14481,
"space_total": 21474836480,
"id": 881525,
"name": "xxx",
"login": "xxx@xxx.com",
"phone": "11111111111",
"email": "xxx@xxx.com",
"profile_pic_key": "ee1bacaffb0128a26b51afaf17126a8b",
"active": true,
"full_name_pinyin": "xxx",
"pinyin_first_letters": "xxx"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| hide_phone | boolean | 是否隐藏手机号 |
| disable_download | boolean | 是否禁用下载 |
| space_used | long | 已用空间，单位为Bytes |
| space_total | long | 总可用空间，单位为Bytes |
| id | long | 用户id |
| name | string | 用户姓名 |
| phone | string | 用户手机 |
| string | 用户邮箱 | |
| login | string | 用户登录名（邮箱或手机） |
| profile_pic_key | string | 用户头像下载所需的key |
| active | boolean | 用户是否激活 |
| full_name_pinyin | string | 用户姓名的拼音字母 |
| pinyin_first_letters | string | 用户姓名的拼音首字母 |
错误码列表
- permission_denied
- user_email_or_phone_invalid
- user_already_invited
- user_already_registered
- user_space_total_exceeds_enterprise_limit
- invalid_enterprise_storage
- cannot_provide_both_phone_and_email
- password_not_null_with_force_active
- user_password_invalid
修改用户
URL
https://open.fangcloud.com/api/v2/admin/user/{id}/update
HTTP请求方式
POST
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 用户id |
POST Body
{
"name": "xxx"
}
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| name | string | 否 | 用户名称，长度不能超过30个字符 |
| storage_id | long | 否 | 用户存储id，非多存储不需要关心 |
| space_total | long | 否 | 用户空间大小，-1为无限，单位为GB |
| hide_phone | boolean | 否 | 是否隐藏手机号，默认为false |
| disable_download | boolean | 否 | 是否禁用下载，默认为false |
返回示例
{
"hide_phone": false,
"disable_download": false,
"space_used": 14481,
"space_total": 21474836480,
"id": 881525,
"name": "xxx",
"login": "xxx@xxx.com",
"phone": "11111111111",
"email": "xxx@xxx.com",
"profile_pic_key": "ee1bacaffb0128a26b51afaf17126a8b",
"active": true,
"full_name_pinyin": "xxx",
"pinyin_first_letters": "xxx"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| hide_phone | boolean | 是否隐藏手机号 |
| disable_download | boolean | 是否禁用下载 |
| space_used | long | 已用空间，单位为Bytes |
| space_total | long | 总可用空间，单位为Bytes |
| id | long | 用户id |
| name | string | 用户姓名 |
| phone | string | 用户手机 |
| string | 用户邮箱 | |
| login | string | 用户登录名（邮箱或手机） |
| profile_pic_key | string | 用户头像下载所需的key |
| active | boolean | 用户是否激活 |
| full_name_pinyin | string | 用户姓名的拼音字母 |
| pinyin_first_letters | string | 用户姓名的拼音首字母 |
错误码列表
- permission_denied
- user_space_total_exceeds_enterprise_limit
- invalid_enterprise_storage
删除用户
URL
https://open.fangcloud.com/api/v2/admin/user/{id}/delete
HTTP请求方式
POST
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 用户id |
POST Body
{
"user_receive_items": 111
}
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| user_receive_items | long | 否 | 接收文件的用户id |
返回示例
{
"success": true
}
错误码列表
- permission_denied
- user_already_deleted
- user_receive_items_needed
- user_received_items_not_in_same_enterprise
- department_director_can_not_delete
- user_deleted_is_user_received_items
- user_receive_items_need_active
获取指定用户登录链接
URL
https://open.fangcloud.com/api/v2/admin/user/get_login_url
HTTP请求方式
GET
URL参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| identifier | string | 是 | 登录凭证，不能为空 |
| type | string | 是 | 凭证类型，分为email、phone和user_ticket三种 |
| platform_id | long | 否 | 平台id，非账号对接企业可忽略 |
user_ticket是账号同步中用户自定义的用户唯一标识
返回示例
{
"login_url": "https://www.fangcloud.com/auth/openapi_login?auth_key=ba5cJOaewi&client_id=test-client",
"expires_in": 300
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| login_url | string | 给指定用户登录用的链接 |
| expires_in | int | 链接有效的时间，单位为秒 |
错误码列表
- permission_denied
- user_already_deleted
- user_not_found
- enterprise_not_enable_sync_account
获取指定用户登录参数
URL
https://open.fangcloud.com/api/v2/admin/user/get_login_params
HTTP请求方式
GET
URL参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| identifier | string | 是 | 登录凭证，不能为空 |
| type | string | 是 | 凭证类型，分为email、phone和user_ticket三种 |
| platform_id | long | 否 | 平台id，非账号对接企业可忽略 |
user_ticket是账号同步中用户自定义的用户唯一标识
返回示例
{
"auth_key": "ejqeobGoeT",
"client_id": "e885b1d0-39e4-49eb-be06-16078cf3f613",
"expires_in": 300
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| auth_key | string | 给指定用户登录用的auth_key |
| client_id | string | 给指定用户登录用的client_id |
| expires_in | int | 链接有效的时间，单位为秒 |
错误码列表
- permission_denied
- user_already_deleted
- user_not_found
- enterprise_not_enable_sync_account
获取指定用户信息
URL
https://open.fangcloud.com/api/v2/admin/user/get_user_info
HTTP请求方式
GET
URL参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| identifier | string | 是 | 登录凭证，不能为空 |
| type | string | 是 | 凭证类型，分为email、phone和user_ticket三种 |
| platform_id | long | 否 | 平台id |
user_ticket是账号同步中用户自定义的用户唯一标识
返回示例
{
"id": 449,
"enterprise": {
"id": 1,
"name": "测试企业",
"admin_user_id": 111
},
"name": "qyang1",
"phone": "15088679770",
"email": "qyang1@admin.com",
"login": "qyang1@admin.com",
"profile_pic_key": "f2b7154b8fa0500004fa0cde46e5e214",
"active": true,
"full_name_pinyin": "qyang1",
"pinyin_first_letters": "qyang1"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 用户id |
| enterprise | object | 企业信息 |
| name | string | 用户姓名 |
| phone | string | 用户手机 |
| string | 用户邮箱 | |
| login | string | 用户登录名（邮箱或手机） |
| profile_pic_key | string | 用户头像下载所需的key |
| active | boolean | 用户是否激活 |
| full_name_pinyin | string | 用户姓名的拼音字母 |
| pinyin_first_letters | string | 用户姓名的拼音首字母 |
错误码列表
- permission_denied
- user_not_found
第三方平台操作
该类接口一般只给混合云企业使用，用于同步AD域中的部门、群组、人员信息到亿方云。接口中所有id类型为string，是混合云用户个性化的id。
批量同步部门
URL
https://open.fangcloud.com/api/v2/admin/platform/{id}/sync_departments
HTTP请求方式
POST
POST Body
{
"departments":[
{
"id": "111",
"name": "111",
"status": 1,
"public_folder": false,
"space_total": 20,
"collab_auto_accepted": true,
"order": 0
}
]
}
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 平台id |
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| departments | list | 是 | 同步的部门信息 |
| departments:id | string | 是 | 个性化部门id |
| departments:name | string | 是 | 部门名称 |
| departments:parent_id | string | 否 | 父部门个性化id，默认为根部门 |
| departments:director_id | string | 否 | 部门管理员个性化id，不提供表示不变更主管，空字符串表示取消主管 |
| departments:status | long | 是 | 同步状态（1表示创建或更新，0表示删除） |
| departments:public_folder | boolean | 否 | 是否创建部门公共资料库，默认为false |
| departments:space_total | int | 否 | 部门空间大小，单位为GB，只能在1-2048之间，默认20G |
| departments:collab_auto_accepted | boolean | 否 | 部门是否自动接受协作邀请，默认为false |
| departments:order | long | 否 | 部门的排序号，默认值为0，越大部门排在越靠上的位置 |
返回示例
{
"success_items_count": 1,
"request_id": "sadasdsd-fgewrsecd-sdfsdwer-sddsf"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| success_items_count | long | 执行成功个数 |
| errors | list | 报错信息 |
| failed_items | list | 失败原因和id列表 |
批量同步群组
URL
https://open.fangcloud.com/api/v2/admin/platform/{id}/sync_groups
HTTP请求方式
POST
POST Body
{
"groups":[
{
"id": "111",
"name": "111",
"status": 1,
"admin_id": "xxx"
}
]
}
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 平台id |
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| groups | list | 是 | 同步的群组信息 |
| groups:id | string | 是 | 个性化群组id |
| groups:name | string | 是 | 群组名称 |
| groups:admin_id | string | 否 | 群组管理员个性化id，默认没有管理员 |
| groups:status | long | 是 | 同步状态（1表示创建或更新，0表示删除） |
返回示例
{
"success_items_count": 1,
"request_id": "sadasdsd-fgewrsecd-sdfsdwer-sddsf"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| success_items_count | long | 执行成功个数 |
| errors | list | 报错信息 |
| failed_items | list | 失败原因和id列表 |
批量同步用户
URL
https://open.fangcloud.com/api/v2/admin/platform/{id}/sync_users
HTTP请求方式
POST
POST Body
{
"default_department_id": "111",
"users":[
{
"id": "111",
"full_name": "111",
"status": 11,
"phone": "xxx",
"email": "xxx@xxx",
"department_ids": ["111"],
"group_ids": ["111"],
"receive_user_id": "user01"
}
]
}
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 平台id |
参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| default_department_id | string | 否 | 默认加入的部门id |
| default_group_id | string | 否 | 默认加入的群组id |
| users | list | 是 | 同步的用户信息 |
| users:id | string | 是 | 个性化用户id |
| users:full_name | string | 是 | 用户名称 |
| users:phone | string | 否 | 用户手机号 |
| users:email | string | 否 | 用户电子邮箱 |
| users:status | long | 是 | 同步状态 |
| users:department_ids | list | 否 | 要加入的部门id列表 |
| users:group_ids | list | 否 | 要加入的群组id列表 |
| users:receive_user_id | string | 否 | 文件交接个性化用户id |
其中，phone和email二者至少传一个 其中同步状态的值以及对应含义
1 => 新增已激活用户，若用户存在，则修改对应信息
2 => 删除用户
3 => 新增未激活用户，发送激活邮件，若用户存在，则修改对应信息
返回示例
{
"success_items_count": 1,
"request_id": "sadasdsd-fgewrsecd-sdfsdwer-sddsf"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| success_items_count | long | 执行成功个数 |
| errors | list | 报错信息 |
| failed_items | list | 失败原因和id列表 |
获取关联用户信息
URL
https://open.fangcloud.com/api/v2/admin/platform/{id}/mapping_user
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 平台id |
URL参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| user_id | string | 否 | 个性化用户id |
| yfy_user_id | int | 否 | 亿方云用户id |
user_id与yfy_user_id只能传一个
返回示例
{
"custom_id": "xxx",
"hide_phone": false,
"disable_download": false,
"space_used": 14481,
"space_total": 21474836480,
"id": 881525,
"name": "xxx",
"login": "xxx@xxx.com",
"phone": "11111111111",
"email": "xxx@xxx.com",
"profile_pic_key": "ee1bacaffb0128a26b51afaf17126a8b",
"active": true,
"full_name_pinyin": "xxx",
"pinyin_first_letters": "xxx"
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| custom_id | string | 账号同步中的自定义用户id |
| hide_phone | boolean | 是否隐藏手机号 |
| disable_download | boolean | 是否禁用下载 |
| space_used | long | 已用空间，单位为Bytes |
| space_total | long | 总可用空间，单位为Bytes |
| id | long | 用户id |
| name | string | 用户姓名 |
| phone | string | 用户手机 |
| string | 用户邮箱 | |
| login | string | 用户登录名（邮箱或手机） |
| profile_pic_key | string | 用户头像下载所需的key |
| active | boolean | 用户是否激活 |
| full_name_pinyin | string | 用户姓名的拼音字母 |
| pinyin_first_letters | string | 用户姓名的拼音首字母 |
错误码列表
- platform_user_not_found
- wrong_platform_id
- cannot_provide_both_yfy_id_and_custom_id
- yfy_id_and_custom_id_not_null
获取关联部门信息
URL
https://open.fangcloud.com/api/v2/admin/platform/{id}/mapping_department
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 平台id |
URL参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| department_id | string | 否 | 个性化部门id |
| yfy_department_id | int | 否 | 亿方云部门id |
department_id与yfy_department_id只能传一个
返回示例
{
"custom_id": "xxx",
"director": {
"id": 881525,
"name": "xxx",
"login": "xxx@test.com"
},
"space_used": 79152336,
"space_total": 21474836480,
"special_users": [],
"hide_phone": false,
"disable_share": false,
"enable_watermark": false,
"collab_auto_accepted": false,
"id": 65820,
"name": "亿方云测试",
"parent_id": 0,
"order": 1
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| custom_id | string | 账号同步中的自定义部门id |
| director | user | 部门管理员信息 |
| space_used | long | 已用空间，单位为Bytes |
| space_total | long | 总共空间，单位为Bytes |
| special_users | array | 特殊成员信息 |
| hide_phone | boolean | 是否隐藏部门成员手机号 |
| disable_share | boolean | 是否禁用分享 |
| enable_watermark | boolean | 是否开启水印预览 |
| collab_auto_accepted | boolean | 是否自动接受协作邀请 |
| id | long | 部门id |
| name | string | 部门名称 |
| parent_id | long | 部门的父部门id |
| order | long | 部门的排序号 |
错误码列表
- platform_department_not_found
- wrong_platform_id
- cannot_provide_both_yfy_id_and_custom_id
- yfy_id_and_custom_id_not_null
获取关联群组信息
URL
https://open.fangcloud.com/api/v2/admin/platform/{id}/mapping_group
HTTP请求方式
GET
路径参数
| 参数字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 平台id |
URL参数说明
| 参数字段 | 字段类型 | 是否必须 | 字段说明 |
|---|---|---|---|
| group_id | string | 否 | 个性化群组id |
| yfy_group_id | int | 否 | 亿方云群组id |
group_id与yfy_group_id只能传一个
返回示例
{
"custom_id": "xxx",
"is_visible": true,
"collab_auto_accepted": true,
"id": 157290,
"name": "autotest_Ldm_1513102763",
"description": "",
"created_at": 1513102764,
"user_count": 0
}
返回字段说明
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| custom_id | string | 账号同步中的自定义群组id |
| collab_auto_accepted | boolean | 是否自动接受协作邀请 |
| is_visible | boolean | 是否可见 |
| id | long | 群组id |
| name | string | 群组名称 |
| description | string | 群组描述 |
| created_at | long | 群组创建时间 |
| user_count | long | 群组成员数 |
错误码列表
- platform_group_not_found
- wrong_platform_id
- cannot_provide_both_yfy_id_and_custom_id
- yfy_id_and_custom_id_not_null
通用对象
File
| 字段 | 类型 | 说明 |
|---|---|---|
| type | long | 固定为"file" |
| id | long | 文件id |
| name | string | 文件名 |
| size | long | 文件大小 |
| created_at | timestamp | 文件创建时间，单位为秒 |
| modified_at | timestamp | 文件修改时间，单位为秒 |
| modified_by | mini_user | 文件修改者简略信息 |
| description | string | 文件描述 |
| path | path_folder列表 | 所有祖先文件夹的简略信息 |
| owned_by | user | 文件所有者 |
| parent | path_folder | 父文件夹简略信息 |
| sequence_id | long | 文件次序号 |
| sha1 | string | 文件sha1 |
| comments_count | long | 评论个数 |
| extension_category | string | 文件扩展名的分类 |
Folder
| 字段 | 类型 | 说明 |
|---|---|---|
| type | string | 固定为"folder" |
| id | long | 文件夹id |
| name | string | 文件夹名称 |
| size | long | 文件夹大小 |
| created_at | timestamp | 文件夹创建时间，单位为秒 |
| modified_at | timestamp | 文件夹更新时间，单位为秒 |
| modified_by | mini_user | 文件夹修改者 |
| description | string | 文件夹描述 |
| path | path_folder列表 | 所有祖先文件夹的简略信息 |
| owned_by | user | 文件夹所有者 |
| parent | path_folder | 父文件夹简略信息 |
| sequence_id | long | 文件夹次序号 |
| item_count | int | 包含item的数量 |
| folder_type | string | 文件夹类型 |
Path Folder
| 字段 | 类型 | 说明 |
|---|---|---|
| type | string | 固定为"folder" |
| id | long | 文件夹id |
| name | string | 文件夹名称 |
User
| 字段 | 类型 | 说明 |
|---|---|---|
| id | long | 用户id |
| enterprise | object | 企业信息 |
| name | string | 用户姓名 |
| phone | string | 用户手机 |
| string | 用户邮箱 | |
| login | string | 用户登录名（邮箱或手机） |
| profile_pic_key | string | 用户头像下载所需的key |
| active | boolean | 用户是否激活 |
| full_name_pinyin | string | 用户姓名的拼音字母 |
| pinyin_first_letters | string | 用户姓名的拼音首字母 |
Share Link
| 返回字段 | 类型 | 说明 |
|---|---|---|
| unique_name | string | 分享标识符 |
| share_link | string | 完整分享链接 |
| access | string | 分享链接权限（公开和企业） |
| password_protected | boolean | 是否有密码 |
| created_at | timestamp | 分享链接创建时间 |
| modified_at | timestamp | 分享链接更新时间 |
| due_time | string | 过期时间 |
| disable_download | boolean | 是否禁止下载 |
| download_count_total | long | 总下载次数 |
| view_count | long | 总查看次数 |
Collab
| 返回字段 | 类型 | 说明 |
|---|---|---|
| id | long | 协作id |
| accessible_by | user | 协作用户 |
| accepted | boolean | 是否接受协作 |
| role | string | 协作角色 |
| item | item | 协作对象 |
Comment
| 返回字段 | 类型 | 说明 |
|---|---|---|
| id | long | 评论id |
| content | string | 评论文本 |
| created_at | long | 评论时间 |
| user | user | 评论用户 |
Enterprise
| 返回字段 | 类型 | 说明 |
|---|---|---|
| id | long | 企业id |
| name | string | 企业名称 |
| admin_user_id | long | 管理员id |
File Version
| 返回字段 | 类型 | 说明 |
|---|---|---|
| id | long | 文件版本id |
| file_id | long | 文件id |
| sha1 | string | 版本sha1 |
| name | string | 版本名称 |
| size | long | 版本大小 |
| modified_at | timestamp | 修改时间 |
| modified_by | mini_user | 修改者 |
| current | boolean | 是否是现在的版本 |
| remark | string | 版本备注 |
| description | string | 版本描述 |
Department
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| created_at | long | 部门创建时间 |
| id | long | 部门id |
| name | string | 部门名称 |
| user_count | long | 部门成员数 |
| children_departments_count | long | 部门的子部门个数 |
| director | user | 部门管理者（可能为null） |
| direct_item_count | long | 部门的item个数 |
| parent_id | long | 部门的父部门id |
Group
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| id | long | 群组id |
| name | string | 群组名称 |
| user_count | long | 群组成员数 |
| description | string | 群组描述 |
| created_at | long | 群组创建时间 |
Admin Department
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| director | user | 部门管理员信息 |
| space_used | long | 已用空间，单位为Bytes |
| space_total | long | 总共空间，单位为Bytes |
| special_users | array | 特殊成员信息 |
| hide_phone | boolean | 是否隐藏部门成员手机号 |
| disable_share | boolean | 是否禁用分享 |
| enable_watermark | boolean | 是否开启水印预览 |
| collab_auto_accepted | boolean | 是否自动接受协作邀请 |
| id | long | 部门id |
| name | string | 部门名称 |
| parent_id | long | 部门的父部门id |
Admin Group
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| collab_auto_accepted | boolean | 是否自动接受协作邀请 |
| id | long | 群组id |
| name | string | 群组名称 |
| description | string | 群组描述 |
| is_visible | boolean | 是否可见 |
Admin User
| 返回字段 | 字段类型 | 字段说明 |
|---|---|---|
| hide_phone | boolean | 是否隐藏手机号 |
| disable_download | boolean | 是否禁用下载 |
| space_used | long | 已用空间，单位为Bytes |
| space_total | long | 总可用空间，单位为Bytes |
| id | long | 用户id |
| name | string | 用户姓名 |
| phone | string | 用户手机 |
| string | 用户邮箱 | |
| login | string | 用户登录名（邮箱或手机） |
| profile_pic_key | string | 用户头像下载所需的key |
| active | boolean | 用户是否激活 |
| full_name_pinyin | string | 用户姓名的拼音字母 |
| pinyin_first_letters | string | 用户姓名的拼音首字母 |
其他
更多接口以及接口详情可参考: https://www.fangcloud.com/share/4c1f1f4a1ff20295966b7fe686
异常处理
异常格式
api接口的异常返回可以分为两类，参数验证错误和业务错误
参数验证错误的返回如又所示:
{
"errors": [
{
"msg": "不能为空",
"code": "request_data_invalid",
"field": "folder_id"
}
],
"request_id": "fdjklsa-asdrwer2312314q-asdfasfav-falsfdjas"
}
参数验证错误有统一的错误码request_data_invalid，具体错误信息会在msg中提示，field提示错误的字段
常见的错误msg包括:
- 不能为null
- 不能为空
- 不能包含null
- 最小不能小于{value}
- 长度需要在{min}和{max}之间
- 个数必须在{min}和{max}之间
业务错误的异常格式如右所示：
{
"errors": [
{
"msg": "文件不存在",
"code": "file_not_found",
}
],
"request_id": "fdjklsa-asdrwer2312314q-asdfasfav-falsfdjas"
}
业务错误通常以不同的code来进行区分
错误码
| code | message |
|---|---|
| request_data_invalid | 请求参数存在错误 |
| permission_denied | 权限不足 |
| file_not_found | 文件不存在 |
| folder_not_found | 文件夹不存在 |
| file_deleted | 文件已删除 |
| folder_deleted | 文件夹已删除 |
| file_in_trash_not_found | 文件不在回收站 |
| folder_in_trash_not_found | 文件夹不在回收站 |
| file_name_conflict | 文件命名冲突 |
| folder_name_conflict | 文件夹命名冲突 |
| folder_empty_in_trash | 回收站无文件夹 |
| folder_parent_deleted | 父文件夹已被删除 |
| move_to_itself | 文件夹不能移动到自身 |
| move_to_subfolder | 不能移动到子文件夹 |
| copy_to_itself | 文件夹不能拷贝到自身 |
| copy_to_subfolder | 不能拷贝到子文件夹 |
| item_name_invalid | 文件或文件夹名称不合法 |
| item_name_size_incorrect | 文件或文件夹名称长度错误 |
| empty_trash | 回收站为空 |
| request_data_invalid | 请求参数错误 |
| exceed_enterprise_space_limit | 超过企业空间限制 |
| exceed_user_space_limit | 超过用户空间限制 |
| folder_is_descendant | 目标文件夹是移动文件夹的子目录 |
| user_not_found | 用户不存在 |
| user_profile_pic_not_found | 用户头像不存在 |
| user_profile_pic_key_not_found | 用户头像的key未传入 |
| user_profile_pic_key_incorrect | 用户头像的key与user_id不匹配 |
| share_link_password_not_provided | 没有提供分享链接密码 |
| share_link_access_type_invalid | 分享链接的 access 类型无效 |
| due_time_passed | 指定的截止时间已过期 |
| share_link_not_found_or_deleted | 分享链接找不到或已删除 |
| share_link_resource_id_not_provided | 没有提供文件或文件夹id |
| share_link_resource_id_ambiguous | 分享链接资源不明确（同时提供了文件和文件夹id） |
| share_link_password_not_correct | 分享链接密码不正确 |
| share_link_password_size_incorrect | 分享链接密码长度最大33位 |
| share_link_password_invalid | 分享链接密码只能使用数字和字母 |
| share_link_expired | 分享链接已过期 |
| collab_not_found | 协作不存在 |
| collab_role_invalid | 协作角色无效 |
| collab_user_has_been_invited | 用户已经被邀请 |
| collab_user_not_in_same_enterprise | 被邀请用户不在同一企业 |
| collab_group_not_supported | 不支持群组协作 |
| cannot_invite_item_owner | 无法邀请拥有者 |
| comment_not_found | 评论不存在 |
| collab_related_folder_deleted | 协作相关的文件夹已经被删除 |
| enterprise_is_expired | 企业套餐已经过期 |
| department_not_found | 部门不存在 |
| department_name_conflict | 部门名冲突 |
| user_not_in_enterprise | 用户不在企业中 |
| user_already_in_department | 用户已经在该部门中 |
| user_exceed_department_limit | 用户所在的部门数超过部门限制(100) |
| user_not_in_department | 用户不在该部门中 |
| group_name_conflict | 群组名冲突 |
| user_already_in_group | 用户已经在该群组中 |
| user_not_in_group | 用户不在该群组中 |
| user_email_or_phone_invalid | 用户邮箱或手机无效 |
| user_already_deleted | 该用户已被删除 |
| user_already_invited | 该用户已被邀请 |
| user_already_registered | 该用户已被注册 |
| user_receive_items_needed | 需要接收文件的用户 |
| department_space_total_exceeds_enterprise_limit | 部门分配空间超出企业总可用空间 |
| department_having_children_can_not_delete | 无法删除存在子部门的部门 |
| user_space_total_exceeds_enterprise_limit | 用户分配空间超出企业总可用空间 |
| user_received_items_not_in_same_enterprise | 接收文件的用户不在同一企业中 |
| invalid_enterprise_storage | 无效的企业存储 |
| department_director_can_not_delete | 无法删除部门管理员 |
| user_deleted_is_user_received_items | 接收文件的用户不能是被删除者 |
| user_not_active | 用户未激活 |
| preview_file_not_generated | 预览文件未生成 |
| can_not_download_yiqixie_file | 无法下载一起写文件 |
| user_receive_items_need_active | 文件接受者尚未激活 |
| timestamp_range_invalid | 非法的时间戳范围 |
| enterprise_not_enable_sync_account | 企业未开启账号同步 |
| cannot_provide_both_yfy_id_and_custom_id | 不能同时提供亿方云id和自定义id |
| yfy_id_and_custom_id_not_null | 亿方云id和自定义id不能同时为空 |
ps:
- 用户传入的json格式错误，返回invalid_error