API Name

API Description

单 key 存储大小限制 2MB。

适用场景：搜索历史、个人偏好设置、当作 mock 数据的接口、适合单人使用的看板工具、...

set-item

调用示例

jetbrains

POST https://open.apihub.net/api/remote-storage/set-item
apihub-token: {{ apihub_person_token }}

{
    "key": "abc",
    "value": "123"
}

curl

curl -X POST \
  "https://open.apihub.net/api/remote-storage/set-item" \
  -H "apihub-token: {{ apihub_person_token }}" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "abc",
    "value": "123"
}'

参数说明

参数	位置	类型	必传	说明
apihub_person_token	Header	str	是
key	jsonBody	str	是
value	jsonBody	any	是	任意类型，可以是 数字、字符串、对象、数组 等等
version	jsonBody	number	否	客户端侧记录的数据版本号。起到类似乐观锁的作用。

返回值说明

{
    "success": true,
    "trace": "0c87177e2f3d11f09886c6807b612ccf",
    "result": {
        "value": "123",
        "version": 1
    }
}

get-item

调用示例

GET https://open.apihub.net/api/remote-storage/get-item?key=abc
apihub-token: {{ apihub_person_token }}

参数说明

参数	位置	类型	必传	说明
apihub_person_token	Header	str	是
key	queryParams	str	是
version	queryParams	number	否	客户端侧记录的数据版本号。如果服务端最新的版本号与参数中的版本号相同，为减少网络传输损耗，将不返回具体数据：{"success": true, "result": null}

返回值说明

{
    "success": true,
    "trace": "0c87177e2f3d11f09886c6807b612ccf",
    "result": {
        "value": "123",
        "version": 1
    }
}

remove-item

调用示例

DELETE https://open.apihub.net/api/remote-storage/remove-item?key=abc
apihub-token: {{ apihub_person_token }}

参数说明

参数	位置	类型	必传	说明
apihub_person_token	Header	str	是
key	queryParams	str	是

返回值说明

{
    "success": true,
    "trace": "0c87177e2f3d11f09886c6807b612ccf"
}