Zum Inhalt springen
Sursa Developers

API-Referenz

Die öffentliche Sursa-API: 222 Endpunkte in 35 Abschnitten. Version 1.62.0.

Die öffentliche Sursa-API für Integrationen, die sich mit einem API-Schlüssel authentifizieren. Änderungen innerhalb von /v1 sind additiv: Neue Operationen, optionale Parameter, Antwortfelder und Enum-Werte in Antworten können hinzukommen, und bestehende Clients funktionieren weiter. Behandeln Sie unbekannte Enum-Werte in Antworten als gültig.

Basis-URL
https://api.sursa.com
Authentifizierung
Senden Sie einen API-Schlüssel im Header Authorization: Authorization: Bearer <Schlüssel>.

Abschnitte

health1 Endpunkt

Dienststatus und Version

auth1 Endpunkt

Anmeldung, Sitzungen, Modus „Ansicht als“, Ändern und Zurücksetzen des Passworts, Annehmen von Einladungen

users5 Endpunkte

Benutzerkonten der Organisation

api-keys9 Endpunkte

API-Schlüssel der Organisation

apps8 Endpunkte

OAuth-Apps der Organisation und Autorisierungen von Mitarbeitenden

oauth3 Endpunkte

Das Protokoll OAuth 2.0: Zustimmungsbildschirm, Ausgabe und Widerruf von Tokens, Metadaten des Autorisierungsservers

audit4 Endpunkte

Audit-Log der Organisation

org1 Endpunkt

Die Organisation, ihr Logo und der Datenexport

categories4 Endpunkte

Dokumentkategorien

collections6 Endpunkte

Wissenssammlungen

cards26 Endpunkte

Wissenskarten: Upload, Inhalt, Tabellen, Versionen, Prüfung, Kommentare

jobs5 Endpunkte

Indexierungswarteschlange: Jobs, Parsing-Vorschau, Änderungsstream (SSE)

conversations2 Endpunkte

Unterhaltungen mit dem Assistenten

answers3 Endpunkte

Antworten der Suche und des Assistenten, einschließlich des SSE-Streams

access-requests4 Endpunkte

Zugriffsanfragen für die Quellen einer verborgenen Antwort

questions10 Endpunkte

Frageprotokoll, Vorschläge, Export von Antworten, Live-Antwort

files8 Endpunkte

Exportdateien

insights1 Endpunkt

Wissensanalysen: Übersicht, Duplikate, Wissenslücken und Zustand des Wissens

tasks1 Endpunkt

Aufgaben eines Benutzers und eines Teams

sources19 Endpunkte

Datenquellen wie Google Drive und Confluence

permissions17 Endpunkte

Zugriffsmodell: das Berechtigungsregister und die Berechtigungen für die Organisation, Sammlungen, Karten und Quellen, sowohl direkt erteilte als auch geerbte

roles4 Endpunkte

Rollen: benannte Sätze von Berechtigungen, integrierte und benutzerdefinierte

groups7 Endpunkte

Benutzergruppen: reguläre Gruppen, „Alle Mitglieder“, Rollengruppen und persönliche Gruppen

folders7 Endpunkte

Ordner von Sammlungen: ein Baum mit bis zu drei Ebenen, Reihenfolge relativ zu einem Nachbarelement, eine Karte in mehreren Ordnern, geerbte Berechtigungen

catalog6 Endpunkte

Katalog externer Dienste (SaaS und Anbieter) mit Namen, Websites, Kategorien, Symbolen und Beschreibungen sowie Verknüpfungen zwischen den Namen Ihrer Organisation und Katalogeinträgen

drafts6 Endpunkte

Entwürfe und Freigabe der Veröffentlichung

verification9 Endpunkte

Prüfung: Status, Fälligkeitsdaten, Prüfer, Verlauf, die Warteschlange „Zuerst prüfen“, Vertrauenswert und Offboarding

announcements5 Endpunkte

Ankündigungen als Pflichtlektüre: Zielgruppe, Lesebestätigung, Berichte, Erinnerungen, Export

comments4 Endpunkte

Kommentarthreads zu Karten mit Anker und Status sowie Reaktionen

webhooks17 Endpunkte

Webhooks der Organisation: Endpunkte, Ereignisabonnements, Signaturen, Zustellungen und Wiederholungen

public-api1 Endpunkt

Öffentliche API für Integrationen: die maschinenlesbare Spezifikation dieser API

uploads5 Endpunkte

Multipart-Uploads großer Dateien: die Sitzung, die Teile, der Abschluss mit Prüfungen und die Verwendung durch eine Karte, ein Archiv oder einen Import

analytics4 Endpunkte

Produktanalysen: Nutzungsereignisse, Zähler pro Objekt, die Dashboards für Zustand, Nutzung und Beiträge, der Verlängerungsbericht und Exporte

quality3 Endpunkte

Antwortqualität: Fragen ohne gute Antwort und Wissenslücken, die in Bearbeitung genommen wurden

finance6 Endpunkte

Finanzdokumente: Wechselkurse und das Verzeichnis der Geschäftspartner

Objekte