Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • fit-connect/docs
1 result
Show changes
Commits on Source (4)
......@@ -11,8 +11,12 @@ Als Voraussetzungen hierfür ist es notwendig, Accounts für [API-Clients im Sel
## Abruf von Access Tokens beim OAuth-Dienst
:::note Hinweis
Die URL der Submission API und die OAuth-Token-URL finden sich im Artikel [Erste Schritte](overview.md#test-infrastruktur).
:::
Fast alle Anfragen an die FIT-Connect Submission API müssen authentifiziert werden.
Hierfür ist ein Access Token notwendig, das beim OAuth-Dienst über die hierfür vorgesehene `Token URL` abgerufen werden kann (siehe Abschnitt `AUTHENTICATION` in der [Schnittstellenspezifikation](../apis/submission-api)).
Hierfür ist ein Access Token notwendig, das beim OAuth-Dienst über die hierfür vorgesehene OAuth-Token-URL abgerufen werden kann.
Für den Abruf von Access Tokens ist die [Konfiguration eines API-Client im Self-Service-Portal](../account.mdx) nötig.
Das Token kann anschließend bei Anfragen über den `Authorization` Header mitgeschickt werden.
......@@ -115,3 +119,7 @@ POST /applications HTTP/1.1
Host: api.zustelldienst-01.example.com
Authorization: Bearer ey...
```
:::note Hinweis
Die URL der Submission API findet sich im Artikel [Erste Schritte](overview.md#test-infrastruktur).
:::
......@@ -8,7 +8,9 @@ import ApiLink from '@site/src/components/ApiLink'
## Abruf von Metadaten und Fachdaten
Der Abruf einer Einreichung ist über den Endpunkt <ApiLink to="/v1/submissions/{submissionId}" /> möglich. Liegen zur Einreichung neben den verschlüsselten Metadaten (`encryptedMetadata`) und Fachdaten (`encryptedData`) zusätzlich weitere Anlagen vor, so sind die IDs der Anlagen im Feld `attachments` zu finden. Anlagen müssen separat heruntergeladen werden (siehe nächster Abschnitt).
Anschließend können die Metadaten und Fachdaten [entschlüsselt](./decrypt.mdx) sowie deren Schemata [validiert](./validate.mdx) werden.
:::note Hinweis
Die URL der Submission API findet sich im Artikel [Erste Schritte](../overview.md#test-infrastruktur).
:::
```bash title="Abfrage der Einreichung inkl. Fachdaten und Metadaten"
$ export SERVICE_URL=<URL>
......@@ -35,6 +37,8 @@ $ curl \
}
```
Anschließend können die Metadaten und Fachdaten [entschlüsselt](./decrypt.mdx) sowie deren Schemata [validiert](./validate.mdx) werden.
## Abruf von Anlagen
Anlagen können über den Endpunkt <ApiLink to="/v1/submissions/{submissionId}/attachments/{attachmentId}" /> abgerufen werden. Anschließend können auch die Anlagen [entschlüsselt werden](./decrypt.mdx).
......
......@@ -134,6 +134,10 @@ Diese Informationen sind:
### 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={[
......
......@@ -14,9 +14,14 @@ Anlagen werden dabei über UUIDs eindeutig identifiziert.
Die UUIDs der Anlagen müssen eindeutig sein und werden vom sendenden System festgelegt.
:::note Hinweis
Die Struktur von Einreichungen und die Referenzierung von Fachdatenschemata ist im Artikel [Aufbau einer Einreichung](../submission-structure.mdx) näher beschrieben.
Die für das Anlegen von Einreichungen notwendige Struktur von Einreichungen und die Referenzierung von Fachdatenschemata ist im Artikel [Aufbau einer Einreichung](../submission-structure.mdx) näher beschrieben.
:::
:::note Hinweis
Die URL der Submission API findet sich im Artikel [Erste Schritte](../overview.md#test-infrastruktur).
:::
<Tabs
defaultValue="curl"
values={[
......
......@@ -19,10 +19,12 @@ hide_table_of_contents: true
| Fachdatensatz (data) | Ist ein strukturierter Fachdatensatz im Rahmen der Einreichung. Kann JSON, XML oder ein anderes in verwaltungseigenen Datenstandards genutztes Datenformat sein. |
| Fachschemareferenz (submission schema) | Das referenzierte Fachschema aus FIM oder XÖV. Eine Liste der möglichen Fachschemata wird im Zustellpunkt angegeben. Das für eine Einreichung verwendete Fachschema steht im Metadatensatz. Siehe auch: Artikel [Fachschemarefenzen auf Fachstandards und Rahmenwerke abbilden](details/schema-reference.md) |
| FIM | Föderales Informationsmanagement, bestehend aus den Bausteinen *FIM Leistungen* (siehe *Leistungsschlüssel*), FIM Datenfelder (siehe *Fachschema*) und FIM Prozesse (Prozessabbildungen zu einer Leistungserbringung). Weiterführende Informationen finden sich im [FIM-Portal](https://fimportal.de/) |
| Gebiet (area) | Eine räumlich abgegrenzte Fläche, z.B. ein Postleitzahlenbereich, ein Naturschutzgebiet oder eine Region im Sinne des Amtlichen Regionalschlüssels (siehe *Region*). |
| Kommunikationskanal (communication channel) | Beschreibt einen Kommunikationskanal, um zwischen der zuständigen Fachbehörde und der Verwaltungskund:in zu digital zu kommunizieren. Kommunikationskanäle können sein: <ul> <li>E-Mail</li> <li>De-Mail</li> <li>FIT-Connect Rückkanal</li> <li>Interoperable Postfächer (FINK)</li> <li>Elster-Transfer des einheitlichen Unternehmenskontos</li> </ul>Eine zuständige Fachbehörde kommuniziert über den Zustellpunkt, welche Kommunikationskanäle unterstützt werden und die Verwaltungskund:in legt fest, welche Kommunikationskanäle genutzt werden sollen. Für die Adressierung der Verwaltungskund:in werden alle für den Kommunikationskanal notwendigen Verbindungs- und Adressierungsparameter (einschließlich ggf. notwendiger Schlüssel/Zertifikate) im Metadatensatz übertragen. |
| Leistungsschlüssel, ehemals *LeiKa-Schlüssel* | Eindeutige Kennung einer Verwaltungsleistung aus dem FIM-Baustein Leistungen (beginnt immer mit `99`). Der Leistungsschlüssel wird im Leistungskatalog der öffentlichen Verwaltung (LeiKa) definiert. Der *Leistungsschlüssel*/*LeiKa-Schlüssel* ist abzugrenzen von der LeiKa-intern verwendeten *LeiKa-ID*, die im Projekt FIT-Connect keine Anwendung findet. Siehe auch: *Leistungs-ID* |
| Leistungs-ID | Eindeutige Kennung einer Verwaltungsleistung. Eine Identifikation des Leistungen erfolgt über eine aus einem Leistungsschlüssel abgeleitete eindeutige URN (z.B. `urn:de:fim:leika:leistung:99010003001006`) |
| Metadatensatz (metadata) | Ein Metadatensatz beschreibt: <ul> <li>Fachunabhängige Metadaten der Einreichung: Authentifizierung des Autors einer Einreichung oder Berichts (bspw. über einen eID-Laufzettel, Identification Report, Informationen über Signaturnutzung einschließlich Angabe des Signaturformats und ggf. separater Signaturdateien), Ergebnisse eines Bezahlvorgangs oder digitale Verbindungs- und Adressparameter für die Verfahrensinformationen (falls vom Verwaltungskund:in gewünscht).</li> <li>Strukturbeschreibung der Einreichung: Art der Leistung und Einreichungsbestandteile.</li> </ul> |
| Region (region) | Eine verwaltungspolitische Region (Gebietskörperschaften) im Sinne des Amtlichen Regionalschlüssels (ARS). Regionen werden in FIT-Connect durch Angabe eines ARS mit vorangestelltem Präfix `DE` identifiziert. Z.B. `DE081150045045`. Siehe auch: *Gebiet* |
| Onlinedienst/Onlineservice (online service) | Ein Onlineservice kann entweder von einer Behörde, einem Unternehmen oder einer zivilgesesellschaftlichen Organisation betrieben wird. Er interagiert in der Art mit FIT-Connect, dass er Anträge im Namen bzw. Auftrag eines Endnutzers verschlüsselt übermittelt. |
| OAuth-Dienst | Der Autorisierungsdienst / OAuth-Dienst stellt Access-Tokens an API-Clients aus, mit denen diese sich anschließend gegenüber dem Zustelldienst (Submission API) authorisieren können. Zugänge für API-Clients können über das Self-Service-Portal konfiguriert werden. |
| Self-Service-Portal | Das Self-Service-Portal ermöglicht es, Accounts/Berechtigungen für die Anbindung von API-Clients anzulegen und Zustellpunkte für empfangende Systeme zu konfigurieren. Siehe Artikel [Accountregistrierung und Client-Verwaltung](account.mdx) sowie [Zustellpunkt anlegen](getting-started/receiving/destination.mdx). |
......