Die Bildschirmaufnahmen zeigen die englische Benutzeroberfläche.

Dieser Leitfaden richtet sich an Entwickler, die ihre Anwendung mit Simbioza verbinden. Die API funktioniert mit Benutzern, Inhalten, Arbeitsbereichen, Kalendern, Umfragen und persönlichen Daten, die dem Schlüsseleigentümer bereits gestattet sind. Es ersetzt nicht die Installationsverwaltung oder die Anmeldung der Teilnehmer bei Umfragen.

Erste Schritte

  1. Ein Administrator installiert/aktiviert API und stellt einen Schlüssel mit den erforderlichen Scopes aus.
  2. Verwenden Sie Erste Schritte, um die Adresse festzulegen und /api/v1/me zu lesen.
  3. Überprüfen Sie die verfügbaren Ressourcen und OpenAPI Ihrer Installation.
  4. Öffnen Sie das Ressourcenkapitel und folgen Sie dem Beispiel zum Erstellen, Lesen, Aktualisieren oder Exportieren.
  5. Behandeln Sie auch Fehler: Der Schlüssel gewährt keinen Zugriff auf die privaten Inhalte eines anderen Benutzers.

Kapitel

Kapitel Verifizierte Operationen
API – Erste Schritte und gemeinsame Regeln 3
API – Benutzer und Gruppen 11
API – Arbeitsbereiche, Bäume, Berechtigungen und Designs 30
API – HTML-Seiten, Entwürfe und Anhänge 22
API – Kalender und Ereignisse 13
API – Umfragen und Ergebnisse 18
API – Aufgaben im Inhalt 4
API – Benachrichtigungen und persönliche Follower 11
API – Webhooks und Zustellungen 9
API – Prüfung und Suche 2
API Grenzen, CalDAV und ICS —

Dieses Handbuch deckt alle 114 registrierten REST-Routen in einer vollständigen Installation ab. Die benannte Aktionsroute „Umfrage“ unterstützt 10 Vorgänge, was 123 separat verifizierte Vorgänge ergibt. Bei einer modularen Installation werden nur Ressourcen verfügbar gemacht, deren Module installiert und aktiv sind. CORS OPTIONS und das separate Protokoll CalDAV liegen außerhalb dieser Summe.

In jedem Beispiel werden Methode, Pfad, Berechtigungen, Parameter, Curl-Befehl, tatsächliche Antwort und verifizierte Fehlercodes angegeben. Die Adresse wird durch Ihren Installationsplatzhalter ersetzt; Schlüssel und Geheimnisse werden nicht veröffentlicht. Antworten verwenden synthetische Daten, daher unterscheiden sich Namen, IDs und Zeitstempel von Ihren. Einige große Antworten verwenden eine explizite jq-Projektion; der angezeigte JSON ist dann die tatsächliche Ausgabe dieses Filters.

Administrator API-Schlüsselverwaltung. Gemeinsame Regeln, Fehler und ein vollständiger PHP-Client.