献给看着目录就想到“API”的人

你的收藏可以离开这个应用,客客气气地。

KolleK 提供了一个有文档的 JSON API,献给想把收藏接入某个脚本、某个仪表盘、自己的导入流程,或某种妙不可言的特定用途的人。

新手上路

简介

鉴定

分页

速率限制

资源

GET 列出藏品
GET 获取藏品
POST 创建藏品
GET 列出收藏
GET 列出位置
GET 列出收藏类型
GET /api/items 由源码生成

列出藏品

检索所有收藏中的藏品,或用查询参数 collection 将列表限定到某一个收藏。返回分页的 item 对象列表。

查询参数

collection string 选填
per_page integer 选填
page integer 选填

个人 API 密钥

同一个目录,供你的工具取用。

用个人 API 密钥,通过简单的 HTTP 请求读取和管理收藏。收藏、藏品、副本、历史、位置等等,都不会被困在界面背后。

collections items copies history locations item-types
创建 API 密钥 设置 · 开发者

名称

家庭仪表盘同步
你的新密钥 复制

14|aB3cD4eF5gH6iJ7kL8mN9oP0qR1sT2uV3wX4yZ5aK

现在就复制。完整密钥只会显示这一次。

编号

来自产品本身的文档。

API 参考由代码库生成。这意味着端点文档被构建为贴近应用实际支持的能力,而不会滑向考古式的虚构。

cURL JavaScript PHP 请求
curl https://kollek.example/api/items \
-H "Authorization: Bearer $KOLLEK_KEY" \
-G --data-urlencode "collection=17" \
--data-urlencode "per_page=2"
200 OK 响应 · application/json
{
"data": [
{ "id": 512,
"name": "Kind of Blue",
"location": "Shelf B2" }
],
"links": { "next": "…?page=2" },
"meta": { "current_page": 1, "total": 128 }
}
基于页码的分页(links + meta) 每用户每分钟 60 次请求 Bearer 令牌认证

互操作性

一个刻意留出的出口。

想在别处分析你的目录?做一份私有报告?把信息挪到另一套流程里?API 给你一条干净的出路,同时不让产品在内部变得更难用。

KolleK API

kollek.app/api

你的目录

一个私有脚本

按计划读取目录,并用它做些具体的事。

你自己的仪表盘

把藏品和位置拉进你亲手搭建的视图里。

一张电子表格

当另一款工具需要这些数据时,导出收藏的一部分。

Webhook

Webhook:一份诚实的状态报告。

如今你已经可以注册带签名的 webhook 端点。产品事件目前还不会触发投递。我们不会把这称作“即将推出”,然后指望你自行脑补其余部分。

Webhook 端点 已注册 1 个
https://hooks.mydash.io/kollek 空闲
签名密钥 whsec_••••••8d2f
签名方案 HMAC-SHA256
投递次数 0
端点注册和签名现已可用。目前还没有任何产品事件会触发投递,因此在此之前,这个端点会一直保持空闲。

读一读参考文档,做出你真正想要的那个东西。

端点、认证、分页和速率限制,皆由代码库生成,为你的密钥准备就绪。

浏览 API 参考

如果符合以下情况,KolleK 可能(暂时)不适合你……

你需要与形形色色各种服务的开箱即用集成。

你现在就需要事件驱动的 webhook。 端点和签名都已具备,但尚无任何产品事件会触发它们。

在以下情况选择 KolleK……

你想要一个有文档的 JSON API 以供你自己的工具和脚本使用。

你现在就需要以令牌认证的方式直接访问目录。

当产品发生变化时,我们会更新此页面。 功能状态页面记录了那些无聊但重要的细节。