Skip to content

Dokumentation Callback-Nutzung

Die Callback-Nutzung soll in der Dokumentation dokumentiert werden.

Akzeptanzkriterien

  • Die Callback-Nutzung ist für Sender und Subscriber beschrieben.
  • Was ist ein Callback? (Auf Webhooks und vergleichbare Konzepte verweisen)
  • Vorteile Callback vs. Polling -> nur im Subscriber-Artikel beschrieben, siehe !33 (diffs)
  • Die Sicherheitsanforderungen inkl. Prüfung von eingehenden Callbacks sind dokumentiert. Siehe https://git.fitko.de/fit-connect/api/-/issues/62
  • Im Artikel "Vorhandensein neuer Einreichungen prüfen" Erläuterungen zu Callbacks ergänzen: Konkrete Anweisungen, wie ein Callback für einen Zustellpunkt konfiguriert werden kann
  • Es gibt Beispiele für mögliche Payloads eines Callback
  • Es wird beschrieben, wie Callbacks manuell ausgelöst und getestet werden können (noch zu definieren).
  • Da das sendende System mit multiplen Zustelldiensten interagiert, muss aus der Benachrichtigung ableitbar sein, bei welchem Zustelldienst sich der API-Client das eigentliche Security Event Token abholt. In der API/Dokumentation ist dokumentiert, dass eine Zuordnung von Callback zu einem Zustelldienst über die im Callback angegebene submissionId zu erfolgen hat. Im Callback selbst darf keine URL des Zustelldienstes enthalten sein.Dies stellt sicher, dass sich API-Clients nur zu bereits bekannten Zustelldiensten verbinden.

Referenzen

Edited by Marco Holz