Einführung in die SecureCloud API

Was ist eine API?

Eine API (Application Programming Interface) ist eine Programmierschnittstelle, die es ermöglicht, dass verschiedene Softwareanwendungen miteinander kommunizieren. Im Kontext von SecureCloud können Sie über die API automatisiert auf Ihre Cloud-Daten zugreifen, Dateien verwalten, Benutzer administrieren und viele weitere Aktionen durchführen – ganz ohne die Weboberfläche nutzen zu müssen.

Die SecureCloud Web API ermöglicht Ihnen die Integration von SecureCloud-Funktionen in Ihre eigenen Anwendungen, Skripte oder Workflows.

Wo finde ich die API-Dokumentation?

Die vollständige API-Dokumentation (nur Englisch) finden Sie unter:

https://support.securecloud.de/reference

Authentifizierung

Die API unterstützt zwei Authentifizierungsmethoden:

Account-Token: Wird mit Benutzername und Passwort generiert und ist für die meisten benutzerbezogenen Aktionen erforderlich. Der Token wird als Bearer-Token im HTTP Authorization-Header übergeben. Für fast alle Endpunkte muss dieser Token übergeben werden.

Repo-Token: Ist spezifisch für eine einzelne Bibliothek (Repository) und kann nur für Operationen innerhalb dieser Bibliothek verwendet werden. Dies ermöglicht eine feingranulare Zugriffskontrolle, wenn Sie beispielsweise einem externen Dienst nur Zugriff auf eine bestimmte Bibliothek gewähren möchten. Sie können Repo-Token für eine Bibliothek über die Web-Benutzeroberfläche unter „Bibliothek Kontextmenü -> Erweitert -> API-Token“ generieren.

Aktionen: Benutzer vs. Administrator

Die API unterscheidet klar zwischen zwei Bereichen:

Benutzer-Aktionen umfassen das Verwalten von Dateien, Ordnern und Bibliotheken sowie das Teilen von Ressourcen und persönliche Einstellungen.

Administrator-Aktionen beinhalten systemweite Operationen wie die Verwaltung von Benutzerkonten, Gruppen, Organisationen, Share-Links, Benachrichtigungen und Protokollen. Diese Endpunkte sind in der Dokumentation mit „System Admin" gekennzeichnet.

Funktionen der API-Dokumentation

Unsere API-Dokumentation bietet Ihnen folgende hilfreiche Funktionen:

Interaktive API-Tests: Sie können API-Aufrufe direkt im Browser ausführen, ohne zusätzliche Tools installieren zu müssen. Geben Sie einfach Ihre Authentifizierungsdaten ein und testen Sie die Endpunkte live.

Code-Snippets: Für jeden API-Endpunkt werden automatisch Code-Beispiele in verschiedenen Programmiersprachen generiert, darunter cURL, Python, JavaScript, PHP, Ruby und weitere. So können Sie den passenden Code direkt in Ihr Projekt kopieren.

Detaillierte Request/Response-Dokumentation: Jeder Endpunkt zeigt Ihnen genau, welche Parameter erwartet werden und wie die Antwort strukturiert ist – inklusive Beispieldaten.

Server-Auswahl: Sie können in der Dokumentation den gewünschten Server auswählen, falls Sie eine eigene SecureCloud-Instanz mit eigener Domain betreiben.

Erste Schritte

Um die API zu nutzen, empfehlen wir folgenden Einstieg:

Öffnen Sie die API-Dokumentation
Starten Sie mit dem Endpunkt „Get Server Information" unter /api2/server-info/ – dieser erfordert keine Authentifizierung und gibt Ihnen Informationen zur Server-Version zurück
Generieren Sie einen Account-Token über den entsprechenden Authentifizierungs-Endpunkt /api2/auth-token/
Erkunden Sie die weiteren Endpunkte entsprechend Ihren Anforderungen, verwenden Sie dort den vorher generierten Account-Token

Hilfe und Support

Bei Fragen zur API-Nutzung erreichen Sie uns unter:

☎️ +49 (0) 9181 - 27 308 -0
📧 [email protected]