すべての機能
記録して把握する
コピー管理 コピー履歴 カスタムカタログ 新着 コレクション分析
所有して共同管理する
データの所有権 共同作業 整理 写真と閲覧
保護して拡張する
保護とケア API セルフホスティング セキュリティ
料金 ドキュメント API よくある質問 GitHub ログイン

カタログを見て「API」と思う人へ

あなたのコレクションは、アプリの外へ出られます。行儀よく。

KolleK には、コレクションをスクリプト・ダッシュボード・自作のインポート処理、あるいは何か素晴らしく具体的なものにつなげたい人のための、文書化された JSON API があります。

ツールボックスを開く

はじめに

はじめに

鑑定

ページ送り

レート制限

リソース

GET アイテム一覧
GET アイテム取得
POST アイテム作成
GET コレクション一覧
GET 保管場所の一覧
GET コレクションタイプの一覧
GET /api/items ソースから生成

アイテム一覧

すべてのコレクションのアイテムを取得するか、クエリパラメーター collection で 1 つのコレクションに絞り込みます。ページネーションされた 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 がほしい 自作のツールやスクリプトのために。

今すぐ、トークン認証でカタログに直接アクセスしたい場合。

製品が変わったら、このページを更新します。 機能ステータスのページに、地味だけれど大事な詳細があります。