FileCap

Öffentliche API-Referenz

Integration und Endpunkte des E-Mail-Plugins

1. Einleitung

Dieses Dokument beschreibt die öffentliche HTTP-API, die vom FileCap-Server bereitgestellt wird. Diese Endpunkte sind für E-Mail-Plugins, Integrationen von Drittanbietern und andere externe Systeme vorgesehen, die Dateien hochladen, Einladungen anfordern, Übertragungsmetadaten validieren oder die Serverkonfiguration auslesen müssen. Interne Endpunkte, die vom Admin-Panel, dem OWA-Add-in und Integrationen mit Partner- bzw. Lizenzservern genutzt werden, fallen nicht in den Geltungsbereich dieses Dokuments.

Die API hat sich in zwei unterschiedlichen Generationen weiterentwickelt:

1. Legacy-API – ein Satz von .jsp URLs (z. B. process_upload.jsp), das früher das Outlook-Classic-Plugin und ähnliche Integrationen unterstützt hat. Jede JSP führt eine serverseitige Weiterleitung an einen modernen REST-Endpunkt durch; sowohl die JSP als auch der moderne Pfad funktionieren weiterhin.
2. Moderne API – JSON-/Multipart-Endpunkte unter /FileCap/api/... die eine strukturierte ApiResult<T> Envelope. Neue Integrationen sollten auf diese Schnittstelle abzielen.

1.1 Basis-URL & Kontextverzeichnis

Alle Endpunkte werden von der FileCap-Webanwendung im Kontextstammverzeichnis bereitgestellt. /FileCap. Die Postman-Sammlung, die mit diesem Dokument geliefert wird, verwendet eine baseURL Variable, die das Schema + den Host (ohne abschließenden Schrägstrich) enthalten sollte, z. B.:

https://filecap.example.com

Die resultierenden URLs werden dann wie folgt gebildet: {{baseURL}}/FileCap/<path>.

1.2 Authentifizierung

Die meisten Endpunkte akzeptieren ein APIKey im Request-Body (Formularfeld, URL-kodierter Parameter oder JSON-Eigenschaft – die modernen Varianten akzeptieren apiKey (ebenso). Der Schlüssel wird pro FileCap-Mandanten konfiguriert und ist für jeden Integrationsaufruf erforderlich, es sei denn, der Endpunkt ist ausdrücklich öffentlich (z. B. password-rules und der validate/* Endpunkte).

Ein Teil der modernen Endpunkte akzeptiert zusätzlich ein deviceApiKey, das vom Geräte-Registrierungsprozess zurückgegeben wird (Abschnitt 9). Endpunkte, die eine Authentifizierung über das Webportal erfordern, verwenden entweder das Portal-Sitzungs-Cookie oder ein JWT-Bearer-Token (Gültigkeitsbereich transfer:free).

1.3 Antwort-Envelope (moderne API)

Moderne JSON-Endpunkte verpacken ihr Ergebnis in:

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

Im Falle eines Fehlers, Erfolg ist falsch, Wert ist null und Fehlermeldung enthält den Grund.

1.4 Antwortformat (Legacy-API)

Das Vermächtnis / *.jsp Endpunkte geben Klartext zurück:

• wahr — Anfrage erfolgreich.
• false|<ERROR_CODE> — Die Anfrage ist fehlgeschlagen; der Code gibt die Ursache an.

1.5 Ratenbegrenzung

Einige Endpunkte unterliegen einer Ratenbegrenzung pro Sitzung, pro JWT oder global. Die Begrenzungen sind, soweit relevant, in der Endpunkt-Referenz aufgeführt. Wird eine Begrenzung überschritten, antwortet der Server mit HTTP 429.

2. Legacy-API (JSP)

Dies sind die ursprünglichen öffentlichen Endpunkte. Sie werden aus Gründen der Abwärtskompatibilität mit bereits implementierten E-Mail-Plugins und Skripten von Drittanbietern beibehalten. Bei neuen Integrationen sollten vorzugsweise die modernen Entsprechungen aus den folgenden Kapiteln verwendet werden; die nachstehende Tabelle zeigt, welche alte URL zu welchem modernen Pfad weiterleitet.

Jeder Legacy-Endpunkt wird im Folgenden ausführlich beschrieben.

2.1 Dateien hochladen — process_upload.jsp

Content-Type: multipart/form-data

Laden Sie eine oder mehrere Dateien in einem einzigen Vorgang hoch. Weiterleiten an /api/transfer/v1/send-outlook-transfer. Gibt Klartext zurück: wahr im Erfolgsfall, false|<ERROR_CODE> im Fehlerfall.

Parameter

Antwort

Klartext.

true
false|VIRUS_FOUND

Fehlercodes

• VIRUS_FOUND — In einer der Dateien wurde ein Virus entdeckt. Die Übertragung wurde abgebrochen.
• NO_RECIPIENT_GIVEN — Für die Überweisung wurden keine Empfänger angegeben.
• FILETYPE_NOT_ALLOW — Dateityp gemäß MIME- oder Erweiterungsrichtlinie nicht zulässig.
• PASSWORT_ERFORDERLICH_ABER_NICHT_ANGEGEBEN — Gemäß den Richtlinien ist ein Passwort erforderlich, es fehlt jedoch.
• CANNOT_SEND_MAIL — FileCap konnte die Benachrichtigungs-E-Mail nicht versenden (Mailserver/Relay falsch konfiguriert).
• API_KEY_INVALID — Der angegebene APIKey ist ungültig.
• GENERAL_ERROR — Unbekannter Fehler; überprüfen Sie das FileCap-Serverprotokoll auf den Stack-Trace. Oft handelt es sich um ein Netzwerk- oder Proxy-Problem.

2.2 Einladung senden — invite.jsp

Content-Type: application/x-www-form-urlencoded

Senden Sie einem externen Benutzer eine FileCap-Einladung und bitten Sie ihn, Dateien für den Einladenden hochzuladen. Weiterleiten an /api/invite/old. Gibt Klartext zurück wahr / false|<ERROR_CODE>.

Parameter

Antwort

Klartext.

true
false|CANNOT_SEND_MAIL

Fehlercodes

• CANNOT_SEND_MAIL — Der Mailserver konnte die Einladungs-E-Mail nicht verarbeiten.
• CANNOT_ADD_INVITE_TO_DB — FileCap konnte die Einladungs-ID nicht speichern.
• UNKNOWN_ERROR — Es ist eine Ausnahme aufgetreten. Überprüfen Sie das Serverprotokoll.

2.3 Einstellungen für das E-Mail-Plugin — mailPluginSettings.jsp

Content-Type: application/x-www-form-urlencoded

Fordern Sie die FileCap-Server-Einstellungen an, die von E-Mail-Plugins (Outlook Classic usw.) verwendet werden. Leitet weiter an /api/settings/outlook-windows. Gibt die Plug-in-Konfiguration als XML zurück.

Parameter

Antwort

XML-Dokument mit Angaben zur maximalen Dateigröße, zu den zulässigen Dateiendungen, zur Passwortrichtlinie, zu den Verifizierungsmethoden, zum Branding usw.

2.4 Datei prüfen — checkFile.jsp

Content-Type: application/x-www-form-urlencoded

Überprüfen Sie – vor dem Hochladen –, ob eine einzelne Datei gemäß den Serverrichtlinien zulässig ist (Blocklisten für Dateiendungen und MIME-Typen, Absenderbeschränkungen). Weiterleitung an /api/validate/file.

Parameter

Antwort

Klartext wahr sofern dies zulässig ist, false|<ERROR_CODE> wenn blockiert.

2.5 Überweisung prüfen — checkTransfer.jsp

Content-Type: application/x-www-form-urlencoded

Eine zuvor erstellte Übertragung überprüfen (wird von E-Mail-Plugins zur Überprüfung des Status bzw. des Inhalts verwendet). Leitet weiter an /api/validate/transfer.

Parameter

Antwort

Antwort im Klartext mit dem Übertragungsstatus und der Dateiliste.

2.6 Domain prüfen — domainCheck.jsp

Content-Type: application/x-www-form-urlencoded

Überprüfen Sie, ob die Absenderdomäne E-Mails an die Empfängerdomäne senden darf (Whitelist / IP-Regeln). Weiterleitung an /api/validate/domain.

Parameter

Antwort

Klartext wahr / false|<ERROR_CODE>.

3. Transfer

Moderne Transfer-Endpunkte unter /FileCap/api/transfer. The send-outlook-transfer Endpoint ersetzt das alte System process_upload.jsp Flow, gibt jedoch anstelle von reinem Text ein strukturiertes JSON-Objekt vom Typ „ApiResult“ zurück. Das /transfer/v1/send-outlook-transfer „endpoint“ ist der Pfad, an den die alte JSP weiterleitet (Textantwort), und wird der Vollständigkeit halber dokumentiert.

3.1 Outlook-Übertragung senden (modern, JSON-Antwort)

Content-Type: multipart/form-data

Upload-Endpunkt für das „Modern Outlook“-Plugin. Gleiche Formularfelder wie process_upload.jsp; die Antwort ist ein JSON ApiResult<ApiUploadValue>. Ratenbegrenzung pro Sitzung (SendOutlookTransfer).

Beispieldatei – Metadatenwert (als einzelnes Textfeld gesendet)

[
  { "filename": "report.pdf", "mimetype": "application/pdf", "size": 102400 },
  { "filename": "photo.jpg",  "mimetype": "image/jpeg",      "size": 51200 }
]

Parameter

Antwort

JSON. Beispiel:

{
  "success": true,
  "value": {
    "transferId": "263478632784632748237513",
    "generatedPassword": "Ax9!kp2Qm"
  },
  "errorMessage": null
}

Anmerkungen

• Ratenbegrenzung: SendOutlookTransfer (pro Sitzung).

3.2 Outlook-Übertragung senden (Legacy v1, Textantwort)

Content-Type: multipart/form-data

Klartext-Variante des Uploads (gibt zurück wahr / false|<ERROR_CODE>). Dies ist der Endpunkt, der process_upload.jsp Weiterleitungen. Verwenden Sie diese Option, wenn der aufrufende Client das alte Format der Textantwort benötigt.

Parameter

Antwort

Klartext.

true
false|API_KEY_INVALID

3.3 Upload validieren (Pre-Flight)

Content-Type: application/json

Überprüfen Sie die Metadaten eines Uploads, bevor Sie Daten übertragen. Dabei werden das Serverkontingent, zulässige Dateiendungen/MIME-Typen, die maximale Größe usw. überprüft. Der Alias-Pfad /transfer/validateUpload funktioniert auch.

Anfrage-Hauptteil

{
  "lang": "NL",
  "fileMetadataList": [
    {
      "fileName": "report.pdf",
      "fileSize": 102400,
      "mimeType": "application/pdf"
    }
  ]
}

Antwort

ApiResult<Void> — nur Erfolg und Fehlermeldung sind ausgefüllt.

3.4 Dateien validieren

Content-Type: application/json

Validierung pro Datei. Gibt pro Datei einen Eintrag zurück, der angibt, ob die Datei zulässig ist, und falls nicht, welche Regel verletzt wurde.

Anfrage-Hauptteil

{
  "lang": "NL",
  "fileMetadataList": [
    { "fileName": "clean.pdf",     "fileSize": 1024, "mimeType": "application/pdf" },
    { "fileName": "forbidden.exe", "fileSize": 2048, "mimeType": "application/x-msdownload" }
  ]
}

Antwort

ApiResult<ValidateFilesResultModel>.

3.5 Empfänger überprüfen

Content-Type: application/json

Überprüfen Sie die Absender-Empfänger-Kombination anhand von Domain-Whitelists, IP-Zulassungslisten und der emailMaySend / E-Mail-Empfang Regeln.

Anfrage-Hauptteil

{
  "senderEmailAddress": "kees@example.com",
  "recipientEmailAddress": "piet@receiver.com"
}

Antwort

ApiResult<Void>.

Fehlercodes

• VALIDATION_ERROR_DOMAIN_INVALID — Die Empfänger- oder Absenderdomain ist nicht zulässig.
• VALIDATION_ERROR_EMAIL_ADDRESS — Eine der E-Mail-Adressen ist fehlerhaft.

3.6 Antwort senden

Content-Type: multipart/form-data

Senden Sie eine sichere Antwort auf eine bestehende Übertragung. Die ursprüngliche Übertragung wird anhand ihrer Übertragungs-ID identifiziert. Ratenbegrenzt (SendReply). Es wird derselbe Multipart-Parser wie in Abschnitt 3.1 verwendet; wenn also Dateiteile angehängt sind, wird die Dateimetadaten Das Feld MUSS vor ihnen stehen.

Parameter

Antwort

ApiResult<SentTransferInfo>.

3.7 Verbindung prüfen

Content-Type: application/json

Leichte Liveness-Prüfung. Gibt immer ApiResult.success("connected") wenn das FileCap-Portal erreichbar ist.

Antwort

Gibt immer Folgendes zurück:

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

4. Einladen

Endpunkte zum Versenden von FileCap-Einladungen. Der gesamte Controller unterliegt einer Ratenbegrenzung von 10 Anfragen pro Minute.

4.1 Einladung senden (modernes JSON)

Content-Type: application/json

Moderne JSON-Variante des alten Formats invite.jsp Ablauf. Akzeptiert eine Liste von Eingeladenen in einem einzigen Anruf.

Anfrage-Hauptteil

{
  "apiKey": "HKADASD68768768ASDASDASDAD",
  "deviceApiKey": "",
  "sender": {
    "emailAddress": "kees@example.com",
    "name": "Kees Janssen"
  },
  "invitees": [
    "piet@company.com",
    "jan@partner.com"
  ],
  "message": "Please upload the requested documents."
}

Antwort

ApiResult<Void>.

Anmerkungen

• Ratenbegrenzung: 10 Anfragen pro Minute (InviteService).

4.2 Einladung senden (altes Formular, /invite/old)

Content-Type: application/x-www-form-urlencoded

Direkter Aufruf des Endpunkts, der invite.jsp leitet weiter an. Gibt Klartext zurück wahr / false|<ERROR_CODE>.

Parameter

Antwort

Klartext wahr / false|<ERROR_CODE>.

4.3 Einladungs-ID generieren

Content-Type: application/json

Generieren Sie die Einladungs-ID, die in der id Feld des alten Einladungsaufrufs (der Wert, der mit iiiii). Alias-Pfad: /invite/generateInviteId.

Anfrage-Hauptteil

{
  "apiKey": "HKADASD68768768ASDASDASDAD",
  "deviceApiKey": "",
  "sender": {
    "emailAddress": "kees@example.com"
  }
}

Antwort

ApiResult<String> — die generierte Einladungs-ID.

5. Einstellungen

Von Clients und Plugins verwendete Server-Einstellungen: Passwortrichtlinie, Optionen zur Empfängerüberprüfung, Branding, Plugin-Einstellungen.

5.1 Passwortregeln (ausführlich)

Content-Type: application/json

Ausführliche Beschreibung der Passwortanforderungen.

Anfrage-Hauptteil

{
  "apiKey": "HKADASD68768768ASDASDASDAD",
  "lang": "NL"
}

Antwort

ApiResult<PasswordRules>:

{
  "success": true,
  "value": {
    "enabled": true,
    "title": "Password requirements",
    "rules": [
      { "description": "At least 8 characters", "requirement": ".{8,}" },
      { "description": "At least one digit", "requirement": "(?=.*\\d)" }
    ]
  }
}

Fehlercodes

• UNEXPECTED_ERROR — Interner Serverfehler; überprüfen Sie das Serverprotokoll.

5.2 Passwortregeln (GET, öffentlich)

Öffentliche, nicht authentifizierte GET-Version. Liefert dasselbe Ergebnis. ApiResult<PasswordRules> body.

Parameter

5.3 Passwortrichtlinie (kurz)

Content-Type: application/json

Kurze Zusammenfassung der Passwortanforderungen: Mindestlänge, Zeichenklassen, Ablaufdatum, Wiederverwendung.

Anfrage-Hauptteil

{
  "apiKey": "HKADASD68768768ASDASDASDAD"
}

Antwort

ApiResult<PasswordPolicy>.

Fehlercodes

• UNEXPECTED_ERROR — Interner Serverfehler; überprüfen Sie das Serverprotokoll.

5.4 Einstellungen für das E-Mail-Plugin (XML)

Content-Type: application/x-www-form-urlencoded

Endpunkt, der mailPluginSettings.jsp weiterleitet. Gibt die Plug-in-Konfiguration als XML zurück.

Parameter

Antwort

XML-Dokument. Wird auch als JSON-Variante unter demselben Pfad bereitgestellt (POST application/json), das den HTTP-Status 202 zurückgibt + ApiResult<OutlookClassicSettings>, oder HTTP 401, wenn die Authentifizierung fehlschlägt.

5.5 Optionen zur Empfängerüberprüfung

Content-Type: application/json

Listet die Verifizierungsmethoden auf, die bei einer Überweisung angewendet werden können (z. B. NONE, EMAIL_ACCESS_CODE, SMS, PASSWORT) und welche davon gemäß den geltenden Richtlinien obligatorisch sind.

Anfrage-Hauptteil

{ "apiKey": "HKADASD68768768ASDASDASDAD" }

Antwort

ApiResult<RecipientVerificationOptions>.

Fehlercodes

• UNEXPECTED_ERROR — Interner Serverfehler; überprüfen Sie das Serverprotokoll.

5.6 App-Einstellungen

Content-Type: application/json

Allgemeines Einstellungsbündel für Client-Apps: aktivierte Funktionen, maximale Upload-Größe, Branding, unterstützte Sprachen usw.

Anfrage-Hauptteil

{
  "apiKey": "HKADASD68768768ASDASDASDAD",
  "lang": "NL"
}

Antwort

ApiResult<AppSettings>.

Fehlercodes

• UNEXPECTED_ERROR — Interner Serverfehler; überprüfen Sie das Serverprotokoll.

5.7 Einstellungen für das Webportal

Rücksendungen ApiResult<WebPortalSettings> für das Webportal (Design, Ländereinstellungen, Feature-Flags). Zulässig für die Portaltypen MAIN, SUB und FREE.

Parameter

5.8 Ist ein gemeinsamer Zugangscode verfügbar?

Content-Type: application/json

Gibt einen rohen Booleschen Wert zurück (wahr / falsch) — nicht in ApiResult eingeschlossen — gibt an, ob für die jeweilige Überweisung ein gemeinsamer Zugangscode konfiguriert wurde.

Anfrage-Hauptteil

{ "transferId": "263478632784632748237513" }

Antwort

Raw-Boolean: wahr oder falsch. Rücksendungen falsch bei jedem internen Fehler.

6. Validierung

Leichte Validatoren, die von Mail-Plugins vor dem Verfassen oder Versenden einer Nachricht aufgerufen werden. Alle Endpunkte unter /api/validate Klartext zurückgeben (wahr / false|<ERROR_CODE>).

6.1 Datei prüfen (Formular)

Content-Type: application/x-www-form-urlencoded

Eine einzelne Datei anhand ihres Namens und ihrer MIME-Typ-Kennung anhand der Policy-Engine validieren. Der Pfad, der checkFile.jsp weiterleitet an.

Parameter

Antwort

Klartext wahr / false|<ERROR_CODE>.

6.2 Überweisung prüfen

Content-Type: application/x-www-form-urlencoded

Pfad, der checkTransfer.jsp weiterleitet an.

Parameter

Antwort

Klartext wahr / false|<ERROR_CODE>.

6.3 Domain prüfen

Content-Type: application/x-www-form-urlencoded

Pfad, der domainCheck.jsp Weiterleitungen an. Überprüft die Absenderdomain anhand der Empfängerdomain.

Parameter

Antwort

Klartext wahr / false|<ERROR_CODE>.

6.4 Der Absender darf senden

Content-Type: text/plain

Gibt einen booleschen Wert für die Frage „Darf dieser Absender über FileCap senden?“ zurück. Der Textkörper enthält die reine E-Mail-Adresse als text/plain.

Antwort

Raw-Boolean: wahr / falsch.

7. Geschäftsregeln (DLP)

Endpunkte für die Richtlinie bzw. die DLP-Engine. Beide Endpunkte erfordern entweder eine DEVICE- oder eine API_KEY-Authentifizierung und unterliegen einer Ratenbegrenzung von 60 Anfragen pro Minute.

7.1 Scan-Anhang

Content-Type: multipart/form-data

Führen Sie einen DLP-/Business-Rules-Scan für einen einzelnen Anhang durch.

Parameter

Antwort

ApiResult<BusinessRulesScanResult> mit dem Scan-Ergebnis und etwaigen Verstößen gegen die Richtlinien.

Anmerkungen

• Ratenbegrenzung: 60 Anfragen pro Minute (ScanAttachment).

7.2 Text scannen

Content-Type: application/json

Führen Sie einen DLP-Scan für beliebigen Text durch.

Anfrage-Hauptteil

{
  "text": "Hello, this is the message body that needs to be scanned for sensitive data."
}

Antwort

ApiResult<BusinessRulesScanResult>.

Anmerkungen

• Ratenbegrenzung: 60 Anfragen pro Minute (ScanText).

8. Blockübertragung

Endpunkte auf der Senderseite, um eine bereits gesendete Übertragung zu überprüfen und zu widerrufen (zu blockieren). Wenn eine Übertragung erstellt wird, speichert FileCap einen Hashwert blockPassword zusammen mit der Übermittlung und den E-Mails erhält der ABSENDER eine Benachrichtigung, die einen Blockierungslink in folgender Form enthält:

https://<host>/FileCap/blockTransfer.jsp?id=<transferId>&blockId=<blockId>&email=<senderEmail>

Die JSP bereinigt die Parameter und leitet zur „Block“-Seite des Portals weiter, die die Übertragungsmetadaten über GET /api/block/info und – nach Bestätigung – Anrufe POST /api/block um die Überweisung tatsächlich zu blockieren. Die blockId Das ist das Geheimnis: Jeder, der über die Transfer-ID, die Block-ID und die E-Mail-Adresse des Absenders verfügt, kann die Überweisung blockieren; es ist weder ein API-Schlüssel noch eine Sitzung erforderlich. Bei jedem Validierungsfehler (falsche Block-ID, falscher Absender, unbekannte Transfer-ID) wird bewusst derselbe allgemeine Fehler zurückgegeben. PORTAL_BLOCK_TRANSFER_NOT_FOUND So kann der Aufrufer nicht erkennen, welches Feld fehlerhaft war.

8.1 Blockinformationen abrufen

Gibt die Metadaten zurück, die die FileCap-Weboberfläche auf der Seite zur Bestätigung des Blocks anzeigt: die TO-Empfänger der Übertragung, die Dateinamen und ein Kennzeichen, das angibt, ob der Nachrichtentext verschlüsselt war. Der Aufruf ist schreibgeschützt – er verändert weder die Übertragung, noch versendet er E-Mails oder schreibt in das Audit-Protokoll.

Validierungsreihenfolge (jeder Fehler wird zusammengefasst zu PORTAL_BLOCK_TRANSFER_NOT_FOUND (sofern nicht anders angegeben):

1. Alle drei Parameter dürfen nicht leer sein;
2. Die Übertragung muss vorhanden sein;
3. SHA-Hash von blockId muss mit dem gespeicherten übereinstimmen blockPassword;
4. E-Mail-Adresse muss ein bekannter Absender der Überweisung sein;
5. Die Übertragung darf nicht deaktiviert sein – andernfalls PORTAL_DOWNLOAD_TRANSFER_ABGELAUFEN;
6. Die Überweisung darf nicht bereits GESPERRT sein – andernfalls PORTAL_BLOCK_TRANSFER_ALREADY_BLOCKED.

Parameter

Antwort

ApiResult<TransferBlockInfo> mit drei Feldern: Empfänger (Array mit E-Mail-Adressen der TO-Empfänger), Dateien (eine Reihe von Dateinamen innerhalb der Übertragung, ohne Pfad) und hasEncryptedMessage (wahr (wenn der Nachrichtentext beim Hochladen verschlüsselt wurde). Beispiel für einen erfolgreichen Nachrichtentext:

{
  "success": true,
  "value": {
    "recipients": ["piet@company.com", "jan@partner.com"],
    "files": ["contract.pdf", "appendix.docx"],
    "hasEncryptedMessage": false
  },
  "errorMessage": null
}

8.2 Blockübertragung

Content-Type: application/json

Markieren Sie die Überweisung als gesperrt. Nach einem erfolgreichen Anruf:

1. Der Übertragungsstatus ist auf „BLOCKED“ gesetzt – nachfolgende Download-Versuche (Webportal oder API) werden abgelehnt;
2. an NTA audit-log entry is written ("user <sender> blocked transfer with id <transferId>");
3. An alle Empfänger in den Feldern „An“ und „CC“ der ursprünglichen Überweisung wird eine Benachrichtigungs-E-Mail mit dem Betreff „Nachricht zurückgezogen“ gesendet.

Parameter (Felder im Request-Body)

Anfrage-Hauptteil

{
  "transferId": "263478632784632748237513",
  "blockId": "BLK-1234",
  "emailAddress": "kees@example.com"
}

Antwort

ApiResult<Void> — nur Erfolg und Fehlermeldung sind ausgefüllt. Mögliche Fehlermeldungen:

• PORTAL_BLOCK_TRANSFER_NOT_FOUND — allgemeiner Sammelbegriff für fehlende Parameter, unbekannte Übertragung, falsche Block-ID, falsche Absender-E-Mail-Adresse oder jede andere unerwartete Ausnahme — bewusst mehrdeutig gehalten, damit der Server nicht preisgibt, welches Feld fehlerhaft war.
• PORTAL_DOWNLOAD_TRANSFER_ABGELAUFEN — Die Übertragung ist bereits abgelaufen (Status DISABLED).
• PORTAL_BLOCK_TRANSFER_ALREADY_BLOCKED — Die Überweisung wurde zuvor blockiert.
• PORTAL_BLOCK_TRANSFER_ERROR — Die Aktualisierung der Datenbank ist fehlgeschlagen.

9. Geräteregistrierung

Endpunkte für die Registrierung eines externen Geräts (eines Systems eines Drittanbieters) beim FileCap-Server, damit dieses die API mit seinem eigenen gerätespezifischen API-Schlüssel aufrufen kann. Der Ablauf ist wie folgt: Registrieren → der Server sendet einen Bestätigungscode per E-Mail → Bestätigen → der Aufrufer erhält ein JWT-/Gerätetoken.

9.1 Gerät registrieren

Content-Type: application/json

Geräteregistrierung starten. Der Server sendet einen Bestätigungscode per E-Mail an E-Mail-Adresse.

Anfrage-Hauptteil

{
  "emailAddress": "kees@example.com",
  "apiKey": "HKADASD68768768ASDASDASDAD",
  "deviceName": "My integration server",
  "lang": "NL"
}

Antwort

ApiResult<Void>.

Anmerkungen

• Ratenbegrenzt (RegisterDevice).

9.2 Gerät überprüfen

Content-Type: application/json

Tauschen Sie den per E-Mail gesendeten Bestätigungscode gegen ein JWT bzw. ein Gerätetoken ein.

Anfrage-Hauptteil

{
  "email": "kees@example.com",
  "verificationCode": "123456"
}

Antwort

ApiResult<String> — das ausgegebene Token.

Anmerkungen

• Ratenbegrenzt (VerifyDevice).