Die API besteht aus zwei Generationen, die parallel zueinander arbeiten: eine Legacy Set (das klassische .jsp-Endpunkte für bestehende Outlook-Plugins) und eine moderne REST-Variante unter /FileCap/api/..., die strukturierte JSON-Antworten zurückgeben. Bei neuen Integrationen sollten vorzugsweise die modernen Endpunkte verwendet werden.

Die wichtigsten Funktionen:

• Transfer – Dateien sicher hochladen und versenden, mit Optionen für Passwörter, SMS-Verifizierung und Ablauffristen
• Einladen – externe Benutzer einladen, dir Dateien zu senden
• Validierung & DLP – Dateien, Domänen und Nachrichten anhand von Sicherheitsregeln überprüfen
• Einstellungen – Passwortrichtlinien und Konfiguration des E-Mail-Plugins abrufen
• Block & Devices – Gesendete Übertragungen widerrufen und externe Geräte mit einem eigenen API-Schlüssel registrieren

Jeder Aufruf wird mit einem API-Schlüssel pro Portal gesichert; ausgewählte Endpunkte unterstützen zusätzlich einen gerätespezifischen Schlüssel oder ein JWT-Token.

‍

Los geht’s

1. Basis-URL festlegen – Alle Endpunkte laufen unter /FileCap. Verwenden Sie Ihre Server-URL ohne Schrägstrich am Ende, zum Beispiel https://filecap.example.com. Aufrufe werden dann wie folgt aufgebaut: {basis-URL}/FileCap/<pad>.
2. API-Schlüssel hinzufügen – frag die APIKey Fragen Sie Ihren Administrator nach den Anmeldedaten Ihres FileCap-Tenants und übermitteln Sie diese bei jedem Aufruf (außer beim öffentlichen validate/*- und Endpunkte für Passwortrichtlinien).
3. Ersten Aufruf durchführen – verwende vorzugsweise die modernen JSON-Endpunkte. Eine erfolgreiche Antwort sieht wie folgt aus:

json

  {
    "success": true,
    "value": { },
    "errorMessage": null
  }

Im Falle eines Fehlers ist Erfolg gleich wie falsch und steht der Grund in Fehlermeldung.

4. Gerät registrieren (optional) – Wenn du mit einem eigenen Geräteschlüssel arbeiten möchtest, registriere dein System bitte über /api/user/devices/register, bestätige den per E-Mail zugesandten Code über /api/user/devices/verify und verwende das erhaltene Token in deinen Aufrufen.

Bitte beachten Sie: Einige Endpunkte unterliegen einer Begrenzung (Rate Limiting). Bei zu vielen Anfragen gibt der Server eine 429-Status wiederherstellen.

‍

‍