Skip to content
Snippets Groups Projects

Informationen zur Konfiguration des Antragsrouting ergänzt

Merged Informationen zur Konfiguration des Antragsrouting ergänzt
mr-routing-configuration into main
Merged Marco Holz requested to merge mr-routing-configuration into main
Compare
and
Show latest version
2 files
+ 132
− 124
Compare changes
  • Side-by-side
  • Inline
Files
2
docs/getting-started/sending/get-destination.mdx
+ 66
− 62
@@ -7,7 +7,7 @@ import ApiLink from '@site/src/components/ApiLink'
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
## Zustellpunkt und `destinationId` ermitteln
## Zustellpunkt und `destinationId` über die Routing API ermitteln
:::caution Hinweis
Bis zur Bereitstellung des Routingdienstes können [Zustellpunkt-Informationen über die Submission API abgerufen werden (siehe unten)](#submissionapi).
@@ -121,6 +121,18 @@ Beispiel für die Response:
}
```
:::note Hinweis
Sofern eine Destination-ID und die Adresse des zuständigen Zustelldienstes bereits bekannt sind, können die in einem Zustellpunkt hinterlegten technischen Parameter auch über den Endpunkt <ApiLink to="/v1/destinations/{destinationId}" /> der Submission API des zuständigen Zustelldienstes [abgerufen werden (siehe unten)](#submissionapi).
:::
Diese Informationen sind:
- Der Status (`status`) gibt an, ob der Zustellpunkt aktiv ist. Nur im Status `active` können neue Einreichungen versendet werden.
- Die Verwaltungsleistungen (`services`), die über diesen Zustellpunkt abgebildet werden, bestehend aus:
- einem Identifikator der Verwaltungsleitung (`identifier`): Typischerweise entspricht dieser einem Leistungsschlüssel aus dem FIM-Baustein Leistungen (ehemals *LeiKa-Schlüssel*, siehe [Leistungskatalog im FIM-Portal](https://fimportal.de/kataloge#download-leistungen)).
- einer Liste an zulässigen Fachdatenschemata (`submissionSchemas`): Hiermit legt das empfangende System fest, welchem Schema die übergebenen Fachdatensätze entsprechen müssen. Welches der angegebenen Schemata verwendet werden muss, bestimmt das sendende System aus dem eigenen fachlichen Kontext heraus. Wenn bspw. ein Antrag für einen Schwerbehindertenausweis gestellt wird, muss der Fachdatensatz aus den dort hinterlegten Schemata gemäß dem dortigen Schema für den Schwerbehindertenausweis (bspw. ein FIM/XFall Schema) entsprechen.
- einer Liste an Regionen (`regions`), für die die Verwaltungsleistung angeboten wird.
- Schlüssel-ID (Key-ID, `kid`) des öffentlichen Verschlüsselungsschlüssels (`encryptionKid`): Empfangende Systeme veröffentlichen die Schlüssel-ID ihres Verschlüsselungsschlüssels für die Verschlüsselung von Einreichungen. Der dazugehörige JSON Web Key (JWK) ist in einer Antwort des Routingdienstes im Attribut `publicKeys` enthalten und kann auch über den Endpunkt <ApiLink to="/v1/destinations/{destinationId}/keys/{keyId}" /> abgefragt werden.
### Inhalt der Adressierungsinformationen (Parameter `destinationSignature`)
Der dekodierte Inhalt (Payload) der Adressierungsinformationen sieht beispielhaft wie folgt aus (Leerzeichen und Zeilenumbrüche dienen ausschließlich der besseren Lesbarkeit):
```json
@@ -253,69 +265,8 @@ boolean verifySSPSignature(SignedJWT signedJWT, String keyId) {
</TabItem>
</Tabs>
:::note Hinweis
Sofern eine Destination-ID und die Adresse des zuständigen Zustelldienstes bereits bekannt sind, können die in einem Zustellpunkt hinterlegten technischen Parameter auch über den Endpunkt <ApiLink to="/v1/destinations/{destinationId}" /> der Submission API des zuständigen Zustelldienstes angefragt werden.
:::
Diese Informationen sind:
- Der Status (`status`) gibt an, ob der Zustellpunkt aktiv ist. Nur im Status `active` können neue Einreichungen versendet werden.
- Die Verwaltungsleistungen (`services`), die über diesen Zustellpunkt abgebildet werden, bestehend aus:
- einem Identifikator der Verwaltungsleitung (`identifier`): Typischerweise entspricht dieser einem Leistungsschlüssel aus dem FIM-Baustein Leistungen (ehemals *LeiKa-Schlüssel*, siehe [Leistungskatalog im FIM-Portal](https://fimportal.de/kataloge#download-leistungen)).
- einer Liste an zulässigen Fachdatenschemata (`submissionSchemas`): Hiermit legt das empfangende System fest, welchem Schema die übergebenen Fachdatensätze entsprechen müssen. Welches der angegebenen Schemata verwendet werden muss, bestimmt das sendende System aus dem eigenen fachlichen Kontext heraus. Wenn bspw. ein Antrag für einen Schwerbehindertenausweis gestellt wird, muss der Fachdatensatz aus den dort hinterlegten Schemata gemäß dem dortigen Schema für den Schwerbehindertenausweis (bspw. ein FIM/XFall Schema) entsprechen.
- einer Liste an Regionen (`regions`), für die die Verwaltungsleistung angeboten wird.
- Schlüssel-ID (Key-ID, `kid`) des öffentlichen Verschlüsselungsschlüssels (`encryptionKid`): Empfangende Systeme veröffentlichen die Schlüssel-ID ihres Verschlüsselungsschlüssels für die Verschlüsselung von Einreichungen. Der dazugehörige JSON Web Key (JWK) ist in einer Antwort des Routingdienstes im Attribut `publicKeys` enthalten und kann auch über den Endpunkt <ApiLink to="/v1/destinations/{destinationId}/keys/{keyId}" /> abgefragt werden.
### Abruf der Zustellpunkt-Informationen über die Submission API {#submissionapi}
Zum Abruf der Zustellpunkt-Informationen stellt die Submission API einen Endpunkt bereit, der über Angabe des Parameters `destinationId` die technischen Parameter der Einreichung für den jeweiligen Zustellpunkt ausgibt.
:::note Hinweis
Die URL der Submission API findet sich im Artikel [Erste Schritte](../overview.md#test-infrastruktur).
:::
<Tabs
defaultValue="curl"
values={[
{ label: 'curl', value: 'curl', },
]
}>
<TabItem value="curl">
Über `curl` können diese Information mit dem folgenden Aufruf abgerufen werden.
```bash
$ export SERVICE_URL=...
$ export JWT_TOKEN=eyJhbGciOiJIUzI1NiJ9.eyJJc3N1Z...NL-MKFrDGvn9TvkA
$ export DESTINATION_ID=7a2668ad-3081-407c-9358-7ce4b6144b02
$ curl \
-H "Authorization: Bearer $JWT_TOKEN" \
-H "Content-Type: application/json" \
-X GET $SERVICE_URL/v1/destinations/$DESTINATION_ID
> {
"destinationId": "7881dba9-4055-4854-8b6d-11ea5b7f3047",
"services": [
{
"identifier": "urn:de:fim:leika:leistung:99010003001006",
"submissionSchemas": [
{
"schemaUri": "https://schema.fitko.de/fim/s00000121_1.0.0.schema.json",
"mimeType": "application/json"
}
],
"regions": [
"DE094750156156",
"DE09330411"
]
}
],
"encryptionKid": "c66e4423-e28d-4a1f-911d-818f9ab60221"
}
```
</TabItem>
</Tabs>
### Verwaltungspolitische Gebiete ermitteln
Falls für die Abfrage der `destinationId` kein amtlicher Gemeindeschlüssel oder ein amtlicher Regionalschlüssel bekannt ist, kann über den Endpunkt [/areas](../../apis/routing-api.mdx#get-/areas) nach passenden verwaltungspolitischen Gebieten gesucht werden.
Der Endpunkt [/areas](../../apis/routing-api.mdx#get-/areas) implementiert Pagination.
@@ -395,3 +346,56 @@ Beispiel für die Response
]
}
```
## Zustellpunkt-Informationen über die Submission API ermitteln {#submissionapi}
Zum Abruf der Zustellpunkt-Informationen stellt die Submission API einen Endpunkt bereit, der über Angabe des Parameters `destinationId` die technischen Parameter der Einreichung für den jeweiligen Zustellpunkt ausgibt.
:::note Hinweis
Die URL der Submission API findet sich im Artikel [Erste Schritte](../overview.md#test-infrastruktur).
:::
<Tabs
defaultValue="curl"
values={[
{ label: 'curl', value: 'curl', },
]
}>
<TabItem value="curl">
Über `curl` können diese Information mit dem folgenden Aufruf abgerufen werden.
```bash
$ export SERVICE_URL=...
$ export JWT_TOKEN=eyJhbGciOiJIUzI1NiJ9.eyJJc3N1Z...NL-MKFrDGvn9TvkA
$ export DESTINATION_ID=7a2668ad-3081-407c-9358-7ce4b6144b02
$ curl \
-H "Authorization: Bearer $JWT_TOKEN" \
-H "Content-Type: application/json" \
-X GET $SERVICE_URL/v1/destinations/$DESTINATION_ID
{
"destinationId": "13ad2349-975c-4167-bcd8-da606b4e1d84",
"status": "active",
"services": [
{
"identifier": "urn:de:fim:leika:leistung:99107004018000",
"submissionSchemas": [
{
"schemaUri": "https://schema.fitko.de/fim/s00000122_1.0.0.schema.json",
"mimeType": "application/json"
}
],
"regions": [
"DE09415061516",
"DE09420411"
]
}
],
"encryptionKid": "e4142167-7f03-4d4f-a8c9-c7ecc78f55f8",
"metadataVersions": [
"1.0.0"
]
}
```
</TabItem>
</Tabs>