API

Eine REST API für Ihren
gesamten Betrieb.

Eine eingeschränkte REST API mit Berechtigungen pro Schlüssel. Authentifizieren Sie sich mit einem Bearer-Token, lesen und schreiben Sie Ihre Module programmgesteuert, und verfolgen Sie jeden Aufruf in der Nutzungsverfolgung und den Zugriffsprotokollen.

Demo buchen Dokumentation lesen

Endpoints

Vorhersehbare, ressourcenbasierte Routen.

GET/api/modules/:id/records

Datensätze auflisten (paginiert, gefiltert, sortiert)

POST/api/modules/:id/records

Einen Datensatz erstellen

GET/api/modules/:id/records/:recordId

Einen einzelnen Datensatz abrufen

PATCH/api/modules/:id/records/:recordId

Einen Datensatz aktualisieren

DELETE/api/modules/:id/records/:recordId

Einen Datensatz löschen

GET/api/modules

Die Module auflisten, auf die ein Schlüssel zugreifen kann

Anfrage und Antwort

Authentifizieren Sie sich mit einem Bearer-Token. Listen-Endpoints geben eine paginierte { data, total }-Hülle zurück.

GET /api/modules/:id/records?page=1&limit=20

Authorization: Bearer osc_live_…

200 OK

{

"data": [ … ],

"total": 248

}

Dokumentation öffnen

API-Schlüssel und Bereiche

Geringstmögliche Berechtigungen von Haus aus.

Bereich pro Schlüssel

Erstellen Sie so viele Schlüssel, wie Sie benötigen. Jeder ist pro Modul mit Lese-, Schreib- und Löschrechten eingeschränkt — ein Schlüssel greift nur auf die Daten zu, auf die er zugreifen soll.

Ratenlimits pro Minute

Legen Sie für jeden Schlüssel ein konfigurierbares Anfragelimit pro Minute fest, mit einem optionalen Ablaufdatum, damit kurzlebige Integrationen nicht länger bestehen als gewünscht.

Nutzungs- und Zugriffsprotokolle

Jeder Aufruf wird nachverfolgt. Prüfen Sie die Nutzung pro Schlüssel und vollständige Zugriffsprotokolle, um den Datenverkehr zu überwachen, Integrationen zu debuggen und zu prüfen, wer worauf zugegriffen hat.

Ratenlimits und Nutzung

Vorhersehbare Limits, volle Transparenz.

Jeder Schlüssel trägt ein konfigurierbares Ratenlimit pro Minute und ein optionales Ablaufdatum. Die Nutzung wird pro Schlüssel zusammen mit vollständigen Zugriffsprotokollen erfasst, sodass Sie den Datenverkehr überwachen, Integrationen debuggen und einen Schlüssel in dem Moment rotieren oder widerrufen können, in dem etwas verdächtig aussieht.

429 Too Many Requests

{

"error": "rate_limited",

"limit": 120,

"retry_after": 14

}

FAQ

Fragen zur API

Jede Anfrage trägt einen API-Schlüssel als Bearer-Token im Authorization-Header (zum Beispiel osc_live_…). Schlüssel werden pro Mandant ausgestellt und laufen nie ab, es sei denn, Sie legen ein optionales Ablaufdatum fest. Jede Anfrage ist auf die diesem Schlüssel gewährten Berechtigungen beschränkt.

Ja. Jeder API-Schlüssel hat ein konfigurierbares Ratenlimit pro Minute. Die Nutzung wird pro Schlüssel mit vollständigen Zugriffsprotokollen erfasst, sodass Sie den Datenverkehr überwachen, Anomalien erkennen und Schlüssel jederzeit rotieren oder widerrufen können.

Schlüssel sind pro Modul mit Lese-, Schreib- und Löschrechten eingeschränkt, sodass ein Schlüssel nur das berührt, was er soll. KI ist von der REST API getrennt und in jedem Plan enthalten — Sie können auf Mandantenebene bei Bedarf Ihren eigenen Anthropic-Schlüssel (BYOK) mitbringen.

Bauen Sie auf Collecta auf.

Sagen Sie uns, was Sie verbinden möchten — wir verschaffen Ihnen einen Schlüssel, Bereiche und eine geführte Tour durch die API.

Demo buchen Dokumentation lesen