[Epic] Destination API im Java & .NET SDK

Warum?

Als Entwickler möchte ich gerne die einfachste Möglichkeit nutzen, um eine API in meinem System zu integrieren. Dabei möchte ich auf keine Funktionalitäten verzichten.

Das Ziel ist es aus den SDKs heraus Zustellpunkte zu erstellen, zu verwalten oder gegebenenfalls zu löschen. Außerdem möchte ich das Schlüssel-Management der Zustellpunkte mit den SDKs steuern.

Relevante Links und Bemerkungen

• Spezifikation der Destination-API: #1802 (closed), https://docs.fitko.de/fit-connect/docs/apis/destination-api
• Destination-API im ZSD: #1788 (closed)

Akzeptanzkriterien und Anwendungsfälle

Übergreifende Akzeptanzkriterien:

• Alle Endpunkte der API sind einfach über die SDKs nutzbar. Ermöglichung folgender Anwendungsfälle:
  1. Alle Zustellpunkte des Clients in eine Liste laden - https://docs.fitko.de/fit-connect/docs/apis/destination-api#get-/v1/destinations
  2. Alle Details zu einem ausgewählten Zustellpunkt laden - https://docs.fitko.de/fit-connect/docs/apis/destination-api#get-/v1/destinations/-destinationId-
  3. Neuen Zustellpunkt anlegen - inkl. JWK-Zuordnung - https://docs.fitko.de/fit-connect/docs/apis/destination-api#post-/v1/destinations & https://docs.fitko.de/fit-connect/docs/apis/destination-api#post-/v1/destinations/-destinationId-/keys
  4. Details zu einem existierenden Zustellpunkt laden (https://docs.fitko.de/fit-connect/docs/apis/destination-api#get-/v1/destinations/-destinationId-) und dann partiell oder vollständig aktualisieren https://docs.fitko.de/fit-connect/docs/apis/destination-api#put-/v1/destinations/-destinationId- & https://docs.fitko.de/fit-connect/docs/apis/destination-api#patch-/v1/destinations/-destinationId-
  5. Löschen eines Zustellpunktes https://docs.fitko.de/fit-connect/docs/apis/destination-api#delete-/v1/destinations/-destinationId-
  6. JWK hinzufügen und optional direkt als aktiven Encryption-Key definieren (https://docs.fitko.de/fit-connect/docs/apis/destination-api#post-/v1/destinations/-destinationId-/keys & https://docs.fitko.de/fit-connect/docs/apis/destination-api#patch-/v1/destinations/-destinationId-)
• Methodensignaturen sind über alle Programmiersprachen ähnlich
• Alle Funktionalitäten des SDKs sind in der Dokumentation integriert mit entsprechenden Code-Beispielen
• Video zur Nutzung des SDKs wurde bereitgestellt
• Kommunikationsmaßnahmen begleitend zur Veröffentlichung der Test- und Produktiv-nutzbaren Version wurden angestoßen

Zudem sollen die folgenden Akzeptanzkriterien in allen Stories dieses Epics eingehalten werden:

• Alle Vorgaben aus den Vorgaben für kryptographische Verfahren werden eingehalten.
• Für die implementierten Funktionalitäten des SDK liegen Unit Tests vor.
• Ein erfolgreicher Integrationstest mit dem jeweiligen SDK wurde durchgeführt.
• Die Library ist thread-safe.
• Die Library kann auch hinter einem HTTP-Proxy genutzt werden.