Skip to content
Snippets Groups Projects
Commit 6a9c9af2 authored by Florian Kaufmann's avatar Florian Kaufmann
Browse files

Merge branch 'migrate-events-retrial-endpoint-docs' into 'main'

Docuanpassung für die event retrival Api Endpunkt Migration

See merge request !56
parents b392bf40 732ecdb1
No related branches found
No related tags found
1 merge request!56Docuanpassung für die event retrival Api Endpunkt Migration
...@@ -82,8 +82,8 @@ Sind alle Prüfungen erfolgreich durchlaufen, wird das SET im Event Log abgespei ...@@ -82,8 +82,8 @@ Sind alle Prüfungen erfolgreich durchlaufen, wird das SET im Event Log abgespei
## Event Log abfragen ## Event Log abfragen
Der Event Log einer Einreichung kann über <ApiLink to="/v1/submissions/{submissionId}/events" /> abgefragt werden. Der Event Log einer Einreichung kann über <ApiLink to="/v1/cases/{caseId}/events" /> abgefragt werden.
Hierbei wird der Event Log der Einreichung zurückgeliefert, der die verschiedenen Statusübergänge bzw. abgelegten Ereignisse beinhaltet. Hierbei wird der Event Log aller Einreichungen eines Cases zurückgeliefert. Dieser Event Log beinhaltet die verschiedenen Statusübergänge bzw. abgelegten Ereignisse.
Es kann über die Queryparameter `offset` und `limit` das Gesamtergebnis in kleinere Teillisten der verfügbaren Events aufgeteilt werden. Es kann über die Queryparameter `offset` und `limit` das Gesamtergebnis in kleinere Teillisten der verfügbaren Events aufgeteilt werden.
Die maximale Anzahl an Events in einer Teilliste (`limit`) sind 500 Events. Die maximale Anzahl an Events in einer Teilliste (`limit`) sind 500 Events.
Das Ergebnis könnte wie folgt aussehen: Das Ergebnis könnte wie folgt aussehen:
...@@ -101,7 +101,7 @@ Das Ergebnis könnte wie folgt aussehen: ...@@ -101,7 +101,7 @@ Das Ergebnis könnte wie folgt aussehen:
} }
``` ```
Im Log dieser Einreichung wurden drei Events aufgezeichnet, wobei das letzte SET das aktuellste ist. Im Log dieses Case wurden drei Events einer Einreichung aufgezeichnet.
Das letzte SET aus obigem Beispiel hat folgenden Payload. Das letzte SET aus obigem Beispiel hat folgenden Payload.
```json ```json
...@@ -125,6 +125,6 @@ In dem SET ist folgende Information abgelegt: ...@@ -125,6 +125,6 @@ In dem SET ist folgende Information abgelegt:
- Die Submission wurde angelegt "accept-submission" (events) - Die Submission wurde angelegt "accept-submission" (events)
- Die Submission gehört zur Vorgangsreferenz (case) `F73D30C6-8894-4444-8687-00AE756FEA90` - Die Submission gehört zur Vorgangsreferenz (case) `F73D30C6-8894-4444-8687-00AE756FEA90`
Aus dem Event des SET lässt sich ableiten, dass der aktuelle Status der Einreichung `accepted` ist und der Zeitpunkt des Übergangs der 04.06.2021 um 08:48:52 GMT+0 war. Aus dem Event des SET lässt sich ableiten, dass der aktuelle Status der Einreichung in diesem Case `accepted` ist und der Zeitpunkt des Übergangs der 04.06.2021 um 08:48:52 GMT+0 war.
Da alle SETs im Event Log signiert sind, kann diese Signatur auch noch überprüft werden. Da alle SETs im Event Log signiert sind, kann diese Signatur auch noch überprüft werden.
Die Überprüfung ist im Artikel zum [Event Log](../event-log.mdx#set-validation) beschrieben. Die Überprüfung ist im Artikel zum [Event Log](../event-log.mdx#set-validation) beschrieben.
...@@ -18,8 +18,8 @@ Wie der Zustellpunkt der zuständigen empfangenden Stelle technisch ermittelt wi ...@@ -18,8 +18,8 @@ Wie der Zustellpunkt der zuständigen empfangenden Stelle technisch ermittelt wi
FIT-Connect möchte einen sehr sicheren Übermittlungsweg bereitstellen, weswegen alle Daten immer vom Browser des Users bis in die Behörde Ende-zu-Ende-Verschlüsselt übertragen werden müssen. FIT-Connect möchte einen sehr sicheren Übermittlungsweg bereitstellen, weswegen alle Daten immer vom Browser des Users bis in die Behörde Ende-zu-Ende-Verschlüsselt übertragen werden müssen.
Das dafür benötigte Schlüsselmaterial wird auch über die Submission API und Routing API bereitgestellt und der Umgang damit im Weiteren erklärt. Das dafür benötigte Schlüsselmaterial wird auch über die Submission API und Routing API bereitgestellt und der Umgang damit im Weiteren erklärt.
Während der Einreichung erhält man von der API eine `submissionId`, mithilfe welcher man nach der Abgabe den Event Log der Einreichung abrufen kann. Während der Einreichung erhält man von der API eine `caseId`, mithilfe welcher man nach der Abgabe den Event Log der Einreichung abrufen kann.
Dieser Event Log enthält eine Liste von Ereignissen, ähnlich wie im Interface einer Paketverfolgung, mit denen der aktuelle Zustellungsstatus der Einreichung transparent wird. Dieser Event Log enthält eine Liste von Ereignissen, ähnlich wie im Interface einer Paketverfolgung, mit denen der aktuelle Zustellungsstatus der Einreichung sowie aller zukünftig zu diesem Case hinzugehörigen Einreichungen transparent wird.
## Prozessablauf ## Prozessablauf
......
...@@ -25,9 +25,9 @@ Das Statusmodell einer Einreichung ist in der folgenden Grafik dargestellt und e ...@@ -25,9 +25,9 @@ Das Statusmodell einer Einreichung ist in der folgenden Grafik dargestellt und e
| `accepted` | Die Einreichung wurde durch den Empfänger akzeptiert. | | `accepted` | Die Einreichung wurde durch den Empfänger akzeptiert. |
Der Status wird über Der Status wird über
<ApiLink to="/v1/submissions/{submissionId}/events"/> <ApiLink to="/v1/cases/{caseId}/events"/>
abgefragt. abgefragt.
Hierbei wird der Event Log der Einreichung zurückgeliefert, der die verschiedenen Statusübergänge bzw. abgelegten Ereignisse beinhaltet. Hierbei wird der Event Log aller Einreichungen eines Cases zurückgeliefert. Dieser Event Log beinhaltet die verschiedenen Statusübergänge bzw. abgelegten Ereignisse.
Es kann über die Queryparameter `offset` und `limit` das Gesamtergebnis in kleinere Teillisten der verfügbaren Events aufgeteilt werden. Es kann über die Queryparameter `offset` und `limit` das Gesamtergebnis in kleinere Teillisten der verfügbaren Events aufgeteilt werden.
Die maximale Anzahl an Events in einer Teilliste (`limit`) sind 500 Events. Die maximale Anzahl an Events in einer Teilliste (`limit`) sind 500 Events.
Das Ergebnis könnte wie folgt aussehen: Das Ergebnis könnte wie folgt aussehen:
...@@ -45,7 +45,7 @@ Das Ergebnis könnte wie folgt aussehen: ...@@ -45,7 +45,7 @@ Das Ergebnis könnte wie folgt aussehen:
} }
``` ```
Im Log dieser Einreichung wurden drei Events aufgezeichnet. Im Log dieses Case wurden drei Events einer Einreichung aufgezeichnet.
Das letzte, aktuellste Security-Event-Token hat folgenden Payload. Das letzte, aktuellste Security-Event-Token hat folgenden Payload.
```json ```json
...@@ -69,7 +69,7 @@ In dem SET ist folgende Information abgelegt: ...@@ -69,7 +69,7 @@ In dem SET ist folgende Information abgelegt:
- Die Submission wurde angelegt "accept-submission" (events) - Die Submission wurde angelegt "accept-submission" (events)
- Die Submission gehört zur Vorgangsreferenz (case) `F73D30C6-8894-4444-8687-00AE756FEA90` - Die Submission gehört zur Vorgangsreferenz (case) `F73D30C6-8894-4444-8687-00AE756FEA90`
Aus dem Event des SET lässt sich ableiten, dass der aktuelle Status der Einreichung `accepted` ist und der Zeitpunkt des Übergangs der 04.06.2021 um 08:48:52 GMT+0 war. Aus dem Event des SET lässt sich ableiten, dass der aktuelle Status der Einreichung in diesem Case `accepted` ist und der Zeitpunkt des Übergangs der 04.06.2021 um 08:48:52 GMT+0 war.
Da alle SETs im Event Log signiert sind, kann diese Signatur auch noch überprüft werden. Da alle SETs im Event Log signiert sind, kann diese Signatur auch noch überprüft werden.
Die Überprüfung ist im Artikel zum [Event Log](../event-log.mdx#set-validation) beschrieben. Die Überprüfung ist im Artikel zum [Event Log](../event-log.mdx#set-validation) beschrieben.
......
...@@ -68,4 +68,4 @@ Die Überprüfung ist im Artikel zum [Event Log](../event-log.mdx#set-validation ...@@ -68,4 +68,4 @@ Die Überprüfung ist im Artikel zum [Event Log](../event-log.mdx#set-validation
:::caution Hinweis :::caution Hinweis
Der Mechanismus zum Abrufen von kryptografischen Schlüsseln des empfangenden Systems zur Signaturprüfung wird sich bis zur Veröffentlichung der finalen API-Spezifikation noch einmal ändern. Der Mechanismus zum Abrufen von kryptografischen Schlüsseln des empfangenden Systems zur Signaturprüfung wird sich bis zur Veröffentlichung der finalen API-Spezifikation noch einmal ändern.
::: :::
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment