API-Änderungen in SecureCloud 13.0

API-Änderungen in SecureCloud 13.0

Mit SecureCloud 13.0 haben sich einige Endpunkte der SecureCloud Web API geändert. Auf dieser Seite finden Sie alles, was Sie bei bestehenden Skripten und Integrationen prüfen sollten. Die vollständige, aktualisierte API-Dokumentation finden Sie wie gewohnt unter https://support.securecloud.de/reference.

📘

Kurz gesagt

Die allermeisten Endpunkte funktionieren unverändert weiter. Anpassen müssen Sie Ihre Integration vor allem dann, wenn Sie Dateikommentare, Freigabelinks auf Ordner oder Einladungen widerrufen per API nutzen.

Entfernte Endpunkte und ihre Nachfolger

BisherNachfolger in SecureCloud 13.0
GET/POST /api2/repos/{repo_id}/file/comments/?p=...GET/POST /api/v2.1/repos/{repo_id}/file/{file_uuid}/comments/
GET/PUT/DELETE /api2/repos/{repo_id}/file/comments/{id}/GET/PUT/DELETE /api/v2.1/repos/{repo_id}/file/{file_uuid}/comments/{comment_id}/
GET /api2/repos/{repo_id}/file/comments/counts/entfällt ersatzlos. Die Kommentarliste einer Datei liefert die Anzahl im Feld total_count.
GET /api2/d/{token}/dir/ (Inhalt eines Ordner-Freigabelinks)GET /api/v2.1/share-links/{token}/dirents/

Dateikommentare werden jetzt nicht mehr über den Dateipfad, sondern über die eindeutige Datei-ID (file_uuid) angesprochen. Die file_uuid erhalten Sie über GET /api/v2.1/smart-link/?repo_id=...&path=...&is_dir=false im Feld smart_link_token. Neu sind außerdem Antworten auf Kommentare (.../comments/{comment_id}/replies/) sowie die Filter resolved, page und per_page.

Geänderte Aufrufe

  • Einladung widerrufen erfolgt per POST /api/v2.1/invitations/{token}/revoke/. Die bisherige Dokumentation nannte fälschlich DELETE.
  • Bibliothek übertragen (PUT /api2/repos/{repo_id}/owner/ und für Administratoren PUT /api/v2.1/admin/libraries/{repo_id}/): Bestehende Freigaben an Benutzer und Gruppen werden nur noch übernommen, wenn Sie reshare=true mitsenden.
  • Bibliothek für alle freigeben (POST /api2/repos/public/): Das Standardrecht ist jetzt Lesen und Schreiben (rw). Wenn Sie nur Leserecht vergeben möchten, senden Sie permission=r ausdrücklich mit.
  • Freigabelinks (/api/v2.1/share-links/) kennen einen Zugriffsbereich user_scope (all_users, specific_users, specific_emails). Das Ablaufdatum kann alternativ per expiration_time (ISO 8601) gesetzt werden. In der Antwort ist permissions ein Objekt.
  • Dateien kopieren und verschieben: Bei Namenskonflikten im Ziel wird automatisch umbenannt, zum Beispiel in „Datei (1).txt“.
  • Statuscodes:
    • Gesperrte Dateien liefern beim Löschen 423 statt 403.
    • „Zu viele Dateien in der Bibliothek“ liefert 447 statt 442.
    • Gruppe anlegen, Gruppenmitglied hinzufügen und Einladung anlegen antworten mit 201.
  • Bild- und Avatargrößen: Der Parameter avatar_size wird nicht mehr ausgewertet, und das Feld avatar_url entfällt bei Gruppen.
  • Favoriten auf gelöschte Elemente werden mit deleted: true geliefert, statt ausgeblendet zu werden.
  • Volltextsuche (/api2/search/): Treffer in Ordnern, die für Sie unsichtbar freigegeben sind, werden nicht mehr zurückgegeben.

Neue Endpunkte

  • Antworten auf Dateikommentare: /api/v2.1/repos/{repo_id}/file/{file_uuid}/comments/{comment_id}/replies/
  • Zuletzt geänderte Dateien einer Bibliothek per Bibliotheks-Token: GET /api/v2.1/via-repo-token/recently-changed-files/
  • Zuletzt gelöschte Dateien einer Bibliothek per Bibliotheks-Token: GET /api/v2.1/via-repo-token/recently-deleted-files/
  • Die Repo-Token-Endpunkte zum Anlegen, Ändern, Sperren, Verschieben, Kopieren und Löschen von Dateien und Ordnern sowie zum Erstellen von Freigabelinks sind jetzt vollständig dokumentiert.

Korrekturen in der Dokumentation

Bei der Umstellung haben wir die gesamte API-Dokumentation mit der Software abgeglichen und dabei auch Fehler der bisherigen Dokumentation behoben. Hat Ihre Integration nach der alten Dokumentation nicht wie erwartet funktioniert, lohnt sich ein Blick auf diese Punkte:

  • Ordnerinhalt auflisten (GET /api2/repos/{repo_id}/dir/): Der Typfilter heißt t, nicht type.
  • Ordner zurücksetzen (PUT /api2/repos/{repo_id}/dir/revert/): Das Feld heißt p, nicht path.
  • Datei verschieben oder kopieren (POST /api/v2.1/repos/{repo_id}/file/): Zusätzlich zu dst_dir ist dst_repo erforderlich.
  • Tags einer Datei abfragen (GET /api/v2.1/repos/{repo_id}/file-tags/): Der Parameter heißt file_path.
  • Gerät entfernen mit Fernlöschung (DELETE /api2/devices/): Der Parameter heißt wipe_device.
  • Abteilungsbibliothek anlegen: Das Passwortfeld heißt passwd.
  • Admin-Freigaben (/api/v2.1/admin/shares/): share_type ist user oder group.
  • Wiki-Endpunkte: Die wiki_id ist die 36-stellige ID der Wiki-Bibliothek, keine Zahl.
  • Snapshots: Die commit_id ist eine 40-stellige Hex-ID.

Hilfe und Support

Bei Fragen zur Umstellung Ihrer Integration erreichen Sie uns unter:


Did this page help you?