diff --git a/docs/getting-started/receiving/query.mdx b/docs/getting-started/receiving/query.mdx index 9dfb6dc18e91bcae31de9b6437d60be9848c270b..720c6c74d1dfd712a585a79137d4afa0598cdbe5 100644 --- a/docs/getting-started/receiving/query.mdx +++ b/docs/getting-started/receiving/query.mdx @@ -13,7 +13,7 @@ Wenn eine Callback-URL im Zustellpunkt hinterlegt ist, kann der Zustelldienst de Das Format, in welchem der Callback übertragen wird, ist im Endpunkt <ApiLink to="/v1/destinations/{destinationId}" withMethod="put" /> definiert. Die Konfiguration und Prüfung von Callbacks ist im Artikel [Verwendung von Callbacks](../../details/callbacks.mdx) beschrieben. -Callbacks zur Benachrichtigung über neue Einriechungen haben das folgende Format: +Callbacks zur Benachrichtigung über neue Einreichungen haben das folgende Format: ```http POST /callbacks/fit-connect diff --git a/news/2021-08-23-sprint-report-cw-34.md b/news/2021-08-23-sprint-report-cw-34.md index 23888dd2ebd3e035431f89d441dc521d48189386..bf70e02335b159c43c6e3827f811ca91a7f043c8 100644 --- a/news/2021-08-23-sprint-report-cw-34.md +++ b/news/2021-08-23-sprint-report-cw-34.md @@ -25,7 +25,7 @@ Interessierten Entwickler:innen stehen folgende Login-Möglichkeiten zur Verfüg Durch die Nutzung des `regions`-Arrays (statt bisher `region`-Attributs) können mehrere Regionen pro Verwaltungsleistung angegeben werden. Siehe [Zustellpunkt ermitteln](https://docs.fitko.de/fit-connect/docs/getting-started/sending/get-destination). #### Alle abholbereiten Einreichungen auflisten / abrufen -Wenn im Zustellpunkt eine Callback-URL hinterlegt ist, kann der Zustelldienst empfangende Systeme direkt via Callback informieren, sobald eine neue Einreichung eingeht. Empfangende Systeme können nun zusätzlich durch Polling, d.h. regelmäßiges Abfragen des Endpuntes `GET /submissions` prüfen, ob neue Einreichungen zur Abholen bereitstehen. Dies wird aus Performancegründen jedoch nicht empfohlen. Der Endpunkt kann zu Testzwecken als Alternative zu Callbacks genutzt werden oder, falls aus technischen Gründen die Nutzung eines Callbacks im Produktivbetrieb nicht möglich ist (bspw. Security Policies im RZ). +Wenn im Zustellpunkt eine Callback-URL hinterlegt ist, kann der Zustelldienst empfangende Systeme direkt via Callback informieren, sobald eine neue Einreichung eingeht. Empfangende Systeme können nun zusätzlich durch Polling, d.h. regelmäßiges Abfragen des Endpunktes `GET /submissions` prüfen, ob neue Einreichungen zur Abholen bereitstehen. Dies wird aus Performancegründen jedoch nicht empfohlen. Der Endpunkt kann zu Testzwecken als Alternative zu Callbacks genutzt werden oder, falls aus technischen Gründen die Nutzung eines Callbacks im Produktivbetrieb nicht möglich ist (bspw. Security Policies im RZ). Die Nutzung des Endpunkts ist im Artikel [Vorhandensein neuer Einreichungen prüfen](https://docs.fitko.de/fit-connect/docs/getting-started/receiving/query#polling) beschrieben. diff --git a/versioned_docs/version-0.14/getting-started/receiving/query.mdx b/versioned_docs/version-0.14/getting-started/receiving/query.mdx index b56c19fb4c46f045c0303a12fa3845613d098092..c6ed2027ae80d82c079734407d0ea750016c51d3 100644 --- a/versioned_docs/version-0.14/getting-started/receiving/query.mdx +++ b/versioned_docs/version-0.14/getting-started/receiving/query.mdx @@ -9,11 +9,11 @@ Empfangende Systeme können sich über den Eingang neuer Einreichungen entweder Letzteres stellt die empfohle Umsetzungsvariante dar, da hierdurch unnötige Anfragen vermieden werden können, was zu einer insgesamt besseren Performance und zu einer schnelleren Benachrichtung empfangnder Systeme führt. ## Callback -Wenn eine Callback-URL im Zustellpunkt hinterlegt ist, kann der Zustelldienst den Zustellpunkt aktiv via Callback über neue Einriechungen informieren. +Wenn eine Callback-URL im Zustellpunkt hinterlegt ist, kann der Zustelldienst den Zustellpunkt aktiv via Callback über neue Einreichungen informieren. Das Format, in welchem der Callback übertragen wird, ist im Endpunkt <ApiLink to="/destinations/{destinationId}" withMethod="put" /> definiert. Die Konfiguration und Prüfung von Callbacks ist im Aritkel [Verwendung von Callbacks](../../details/callbacks.mdx) beschrieben. -Callbacks zur Benachrichtigung über neue Einriechungen haben das folgende Format: +Callbacks zur Benachrichtigung über neue Einreichungen haben das folgende Format: ```http POST /callbacks/fit-connect @@ -26,7 +26,7 @@ callback-timestamp: 1672527599 Wenn das empfangende System über den Eingang neuer Einreichungen benachrichtigt wurde, dann kann es diese wie im Artikel [Einreichung herunterladen](./download-submission.mdx) beschrieben herunterladen. ## Polling -Über Polling, d.h. regelmäßiges Abfragen des Endpuntes <ApiLink to="/submissions" /> , können alle Einreichungen abgefragt werden, die zum Abholen bereitstehen. +Über Polling, d.h. regelmäßiges Abfragen des Endpunktes <ApiLink to="/submissions" /> , können alle Einreichungen abgefragt werden, die zum Abholen bereitstehen. Dies wird aus Performancegründen jedoch nicht empfohlen. Die abgerufene Liste der Submissions kann über den Parameter `destinationId` auf einzelne Zustellpunkte eingeschränkt werden.