开放 API

自己动手,创造专属的收藏小应用

Cubox 目前开放了用来收藏常见内容的 API 接口。支持收藏网页和速记。

开放 API 为高级会员独享功能,你可以配合其它工具,或开发自己的收集小应用,来满足日常工作流程的个性化需求。

在 Cubox 网页版 设置 > 扩展与下载 中,找到 开放 API 设置项。点击 启用 API 以获得你自己的 API 链接。

API 链接是你个人身份的唯一凭证,请勿泄露以防它人滥用。你可以点击刷新按钮重新生成一个新的 API 链接,此时旧的链接会失效。

post
保存网页

https://cubox.pro/c/api/save/K92ndHGW6td8o9(系统为你生成的 API 链接)
通过一个网页的 URL 来保存这个网页到你的 Cubox 帐户。
Request
Response
Request
Body Parameters
type
required
string
url
content
required
string
网站的完整 URL, 包含 https:// 或 http://
title
optional
string
收藏后的卡片标题,可为空。
description
optional
string
收藏后的卡片描述,可为空。
tags
optional
array
给这个收藏添加一个或多个标签。
folder
optional
string
指定要存放到的收藏夹位置,如果找不到这个收藏夹,系统将自动创建一个新的。
Response
200: OK
HTTP 状态码说明: 200: 成功 400: 参数错误 -1100: API Key 错误 -1025: 需要升级会员使用 -3030: 调用次数超过 200次/天限制 -1102: 不支持的 Type 类型 -1: 未知错误
{
"message": "",
"code": 200
} json 格式范例:

仅支持 json 格式的请求,范例:

{
"type":"url",
"content":"https://apple.com",
"title":"标题",
"description":"描述",
"tags":["标签A","标签B","标签C"],
"folder":"收藏夹名称"
}

收藏成功后,Cubox 云端会自动开始进行文章解析、快照存档等一处理,可能需要些时间。

post
保存速记

https://cubox.pro/c/api/save/K92ndHGW6td8o9(系统为你生成的 API 链接)
快速保存一段文字速记到 Cubox。
Request
Response
Request
Body Parameters
type
required
string
memo
content
required
string
你要收藏的纯文字内容,不超过 3000 字。
title
optional
string
收藏后的卡片标题,可为空。
description
optional
string
收藏后的卡片描述,可为空。
tags
optional
array
给这个收藏添加一个或多个标签。
folder
optional
string
指定要存放到的收藏夹位置,如果找不到这个收藏,系统将自动创建一个新的。
Response
200: OK
HTTP 状态码说明: 200: 成功 400: 参数错误 -1100: API Key 错误 -1025: 需要升级会员使用 -3030: 调用次数超过 200次/天限制 -1102: 不支持的 Type 类型 -1: 未知错误
{
"message": "",
"code": 200
}

仅支持 json 格式的请求,范例:

{
"type":"memo",
"content":速记的文本内容",
"title":"标题",
"description":"描述",
"tags":["标签A","标签B","标签C"],
"folder":"收藏夹名称"
}

如果不指定标题或描述,Cubox 会尝试帮你生成。 如果不指定收藏夹,内容会默认收藏到你的收件箱。

高级用户每天可调用 200 次 API

分享你的作品

如果你有任何发挥 Cubox 收集 API 的作品,欢迎通过邮件 [email protected] 分享给我们,以及更多 Cubox 用户。