CHANGELOG.md

Changelog

Das Format dieser Datei basiert auf Keep a Changelog.

[Unveröffentlicht] - ????-??-??

Diese Version beinhaltet breaking changes

Allgemein

• Reduktion der Verarbeitung von personenbezogenen Daten
• Daten eines Antrags müssen nun Ende-zu-Ende verschlüsselt übertragen werden
• API-Endpunktstruktur hat sich verändert, um
  • die Pfade einfacher und kürzer zu gestalten
  • und nur Parameter zu erfassen, die auch benötigt werden
• Hinzugefügt: Endpunkt /status zur Prüfung ob der Zustelldienst verfügbar ist.

Destinations

Der Aufbau & Umfang von Destination-Objekten hat sich geändert:

• Das Attribut publicOrganization entfällt, weil
  • nur Kontaktinformationen für den Fall von technischen Problemen erfasst und hierbei so wenig Informationen wie möglich gespeichert werden sollen.
  • Der Name der Organisation ist als Attribut für eine bessere Zuordnung zu contactInformation unter legalName gewandert.
• Das Attribut technicalContact wird umbenannt zu contactInformation und inhaltlich wie im Beispiel unten geändert
• Die Attribute callback und callbackURI wurden zusammengeführt,
  • um die Struktur flacher zu gestalten,
  • und weil neben callbackURI keine anderen Attribute angeordnet sind.
• Im Attribut schemas entfällt das Attribut encoding,
  • da ab Version 1 jede Kommunikation Ende-zu-Ende verschlüsselt sein muss.
• Das Attribut publicKey wurde umbenannt zu encryptionKid. Weiterhin wurde ein Feld keys eingefügt.
  • encryptionKid: Die KeyId des Schlüssels der zur Verschlüsselung der an einen Zustellpunkt gesendeten Daten verwendet wird. Der Schlüssel ist abrufbar im Attribut keys.
  • keys: Hier befinden sich die öffentlichen Schlüssel des Zustellpunktes.
  • Der signingKid fehlt, da dieser an signierten Nachrichten mit angehängt wird und ebenso im Attribut keys auffindbar ist.
• Ein Schema besteht nun aus einer schemaURI und optional einem Feld mimeType.
  • Wurde im Zuge der Vereinfachung so umgesetzt. URLs und URNs können in das Feld schemaURI eingetragen werden.

{
  "contactInformation": {
    "legalName": "Max",
    "address": "Mustermann",
    "phone": "+49170123456789",
    "email": "max@mustermann.not",
    "unit": "Musterabteilung XYZ"
  },
  "schemas": [
    {
      "schemaURI": "urn:fitko:schema-x"
    }
  ],
  "callback": "http://127.0.0.1:4010/voluptas",
  "keys": {
    "my-key-id": {
      
    }
  },
  "encryptionKid": "my-key-id"
}

Get Destination

• destinationId
• schemas
• encryptionKid
• keys

Das Attribut contact (vormals technicalContact) wird nicht mehr zurückgegeben, da dies schützenswerte Informationen sind.

Update Destination

• Attribut destinationId ist nicht länger aktualisierbar, da die Id vom Service und nicht vom Nutzer der API verwaltet wird
• Liefert jetzt bei erfolgreicher Aktualisierung die öffentlichen Attribute des Zustellpunktes zurück, anstatt vorher nur { "result": "success" }.

Create Destination

Liefert jetzt bei erfolgreichem Erstellen die öffentlichen Attribute des Zustellpunktes zurück, anstatt vorher nur die destinationId.

Delete Destination

Eigentlich müsste dieser Endpunkt gar keinen Body mitliefern. Damit nicht-konforme Middleware den Request trotzdem sauber routen kann, liefert er jetzt {} anstatt { "result": "success" } zurück.

Application Transfer