Skip to content

五彩 API

目前仅限PRO会员可使用。

所有接口都使用 POST + JSON 格式发送。

接口返回 code 为 1 代表调用成功(这里并非是 0)。

从五彩管理后台生成 API 链接

点击这里查看OpenAPI链接

复制线框里的链接,得到 create API。 alt text

发送信息接口

API:$baseAPI/create
Method: POST + json
Params: 
content: 文本内容, string

CURL 提交 demo

bash
curl --location --request POST '这里写 createAPI' \
--header 'Content-Type: application/json' \
--data-raw '{
    "content": "这里是内容"
}'

获取单个页面划线列表接口

五彩后台默认显示的是 create API,将地址里的 /create 改成 /highlights ,就能得到划线列表接口。

API: $baseAPI/highlights
Method: POST + json
Params:

url string 页面地址

demo

bash
curl --location --request POST 'https://api.wucai.site/xxxxx/highlights' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url":"https://mp.weixin.qq.com/s?__biz=MzU2MTgzMjQyMA==&mid=2247483768&idx=1&sn=1a7a523dc4a9da6b6d73a5a86d26cdca&chksm=fc7389f3cb0400e504dd945d7e051c9ab3898756230f3fbb30cbc0ccf067b450818e50badcfe&scene=21#"
}'

返回字段说明

  1. refid string 划线id
  2. slotid int 1~6, 分别对应划线的 6 个颜色
  3. note string 划线内容
  4. imageurl string 如果是图片划线,这里是图片的地址
  5. anno string 划线想法

slotid 说明,不管选择的是什么颜色主题,slotid值相同的颜色也是相近的。