Für alle, die einen Katalog ansehen und „API“ denken

Ihre Sammlung darf die App verlassen. Höflich.

KolleK hat eine dokumentierte JSON-API für alle, die ihre Sammlung mit einem Skript, einem Dashboard, einem eigenen Importprozess oder etwas wunderbar Spezifischem verbinden wollen.

Erste Schritte

Einführung

Authentifizierung

Seitennummerierung

Ratenbegrenzungen

Ressourcen

GET Objekte auflisten
GET Objekt abrufen
POST Objekt erstellen
GET Sammlungen auflisten
GET Standorte auflisten
GET Sammlungstypen auflisten
GET /api/items AUS DEM QUELLCODE GENERIERT

Objekte auflisten

Rufen Sie Objekte aus allen Sammlungen ab oder beschränken Sie die Liste mit dem Query-Parameter collection auf eine Sammlung. Gibt eine paginierte Liste von Item-Objekten zurück.

Query-Parameter

collection string optional
per_page integer optional
page integer optional

Persönliche API-Schlüssel

Derselbe Katalog, verfügbar für Ihre Werkzeuge.

Nutzen Sie einen persönlichen API-Schlüssel, um die Sammlung über einfache HTTP-Anfragen zu lesen und zu verwalten. Sammlungen, Objekte, Exemplare, Verlauf, Standorte und der Rest sind nicht hinter der Oberfläche gefangen.

collections items copies history locations item-types
API-Schlüssel erstellen Einstellungen · Entwickler

Name

Haushalts-Dashboard-Sync
Ihr neuer Schlüssel Kopieren

14|aB3cD4eF5gH6iJ7kL8mN9oP0qR1sT2uV3wX4yZ5aK

Kopieren Sie ihn jetzt. Der vollständige Schlüssel wird nur dieses eine Mal angezeigt.

Referenz

Dokumentation, die aus dem Produkt kommt.

Die API-Referenz wird aus dem Code generiert. Die Endpunkt-Dokumentation bleibt so nah an dem, was die App tatsächlich unterstützt, statt in archäologische Fiktion abzudriften.

cURL JavaScript PHP Anfrage
curl https://kollek.example/api/items \
-H "Authorization: Bearer $KOLLEK_KEY" \
-G --data-urlencode "collection=17" \
--data-urlencode "per_page=2"
200 OK Antwort · application/json
{
"data": [
{ "id": 512,
"name": "Kind of Blue",
"location": "Shelf B2" }
],
"links": { "next": "…?page=2" },
"meta": { "current_page": 1, "total": 128 }
}
Seitenbasierte Paginierung (links + meta) 60 Anfragen / Min. pro Nutzer Bearer-Token-Authentifizierung

Interoperabilität

Ein Notausgang, mit Absicht.

Sie möchten Ihren Katalog anderswo analysieren? Einen privaten Bericht bauen? Informationen in einen anderen Workflow bringen? Die API bietet Ihnen einen sauberen Weg hinaus, ohne das Produkt drinnen weniger nützlich zu machen.

KolleK-API

kollek.app/api

Ihr Katalog

Ein privates Skript

Lesen Sie den Katalog nach Zeitplan und machen Sie etwas Bestimmtes damit.

Ihr eigenes Dashboard

Holen Sie Objekte und Standorte in eine Ansicht, die Sie selbst gebaut haben.

Eine Tabelle

Exportieren Sie einen Teil der Sammlung, wenn ein anderes Werkzeug die Daten braucht.

Webhooks

Webhooks: ehrlicher Statusbericht.

Sie können heute signierte Webhook-Endpunkte registrieren. Produktereignisse lösen noch keine Zustellungen aus. Wir werden das nicht „demnächst“ nennen und darauf hoffen, dass Sie sich den Rest denken.

Webhook-Endpunkte 1 registriert
https://hooks.mydash.io/kollek Inaktiv
Signaturgeheimnis whsec_••••••8d2f
Signaturschema HMAC-SHA256
Zustellungen 0
Endpunktregistrierung und Signierung funktionieren bereits. Noch löst kein Produktereignis eine Zustellung aus, daher bleibt dieser Endpunkt bis dahin inaktiv.

Lesen Sie die Referenz. Bauen Sie das, was Sie wirklich wollten.

Endpunkte, Authentifizierung, Paginierung und Ratenbegrenzungen, aus dem Code generiert und bereit für Ihren Schlüssel.

Die API-Referenz erkunden

KolleK ist vielleicht (noch) nichts für Sie, wenn…

Sie brauchen schlüsselfertige Integrationen mit jedem erdenklichen Dienst.

Sie brauchen schon heute ereignisgesteuerte Webhooks. Endpunkte und Signierung existieren, aber noch löst kein Produktereignis sie aus.

Wählen Sie KolleK, wenn…

Sie möchten eine dokumentierte JSON-API für Ihre eigenen Werkzeuge und Skripte.

Sie brauchen jetzt direkten, tokenauthentifizierten Zugriff auf den Katalog.

Wir aktualisieren diese Seite, wenn sich das Produkt ändert. Die Statusseite der Funktionen enthält die langweiligen, aber wichtigen Details.