diff --git a/docs/changelog.md b/docs/changelog.md index 18a156dcb63f980218117ec1bad6665f952d4058..8d99f0508eb6d6db1388f260f4ee38b5b678d5b8 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -2,7 +2,7 @@ Das Format dieser Datei basiert auf [Keep a Changelog](https://keepachangelog.com/de). -Das hier veröffentlichte Changelog bezieht sich auf die [Testinstanz von FIT-Connect](https://docs.fitko.de/fit-connect/docs/getting-started/get-started#testing). +Das hier veröffentlichte Changelog bezieht sich auf die [Testinstanz von FIT-Connect](https://docs.fitko.de/fit-connect/docs/getting-started/environments). ## 2022-10-17 diff --git a/docs/getting-started/authentication.mdx b/docs/getting-started/authentication.mdx index 7dd5a97a370543a27691f988d669ad3b4d785368..9a9a8f4e9edb42eafaab25bba3f3818f3a704172 100644 --- a/docs/getting-started/authentication.mdx +++ b/docs/getting-started/authentication.mdx @@ -12,7 +12,7 @@ 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](get-started.mdx#testing). +Die URL der Submission API und die OAuth-Token-URL finden sich im Artikel [Betriebsumgebungen](./environments.mdx#testing). ::: Fast alle Anfragen an die FIT-Connect Submission API müssen authentifiziert werden. @@ -125,5 +125,5 @@ Authorization: Bearer ey... ``` :::note Hinweis -Die URL der Submission API findet sich im Artikel [Erste Schritte](get-started.mdx#testing). +Die URL der Submission API findet sich im Artikel [Betriebsumgebungen](./environments.mdx#testing). ::: diff --git a/docs/getting-started/environments.mdx b/docs/getting-started/environments.mdx new file mode 100644 index 0000000000000000000000000000000000000000..94beac24b0c3d401fa43c194ed83c7a163532f34 --- /dev/null +++ b/docs/getting-started/environments.mdx @@ -0,0 +1,43 @@ +--- +title: Betriebsumgebungen +--- + +# Betriebsumgebungen der FIT-Connect-Infrastruktur +## Übersicht +Für FIT-Connect stehen derzeit mehrere Betriebsumgebungen bereit, die jeweils einen etwas anderen Zweck erfüllen. +Umgebungen, die von der FITKO zu Test- und Entwicklungszwecken bereitgestellt werden, stehen unter einer Subdomain unterhalb von `fitko.dev` zur Verfügung. +Produktive und produktivnahe Umgebungen stehen unter einer Subdomain unterhalb von `fitko.net` (bzw. unterhalb von `niedersachsen.de` für die bei IT.Niedersachsen betriebenen Infrastrukturen) zur Verfügung. + +| Umgebung | Zweck und Zielgruppe | +| ---------------------------------- | -------------------- | +| Testumgebung (`testing`) | **Zweck**: Die Testumgebung dient vorrangig Anbindungstests und der Erprobung neuer Features.<br/>**Zielgruppe**: Die Testumgebung steht allen Interessierten zur freien Nutzung zur Verfügung, darf nicht für produktive Zwecke genutzt werden und unterliegt keinerlei Verfügbarkeitsgarantien.<br/>**Besonderheiten**: In der Testumgebung können selbst-generierte Test-Zertifikate anstelle von Zertifikaten aus einer PKI-Infrastruktur genutzt werden. | +| Staging-/Referenzumgebung (`refz`) | **Zweck**: Die Stagingumgebung, auch Referenzumgebung genannt, ist identisch zur Produktivumgebung konfiguriert und dient dem Test von Updates der an FIT-Connect angebundenen Systeme, bevor diese an die Produktivumgebung angebunden werden. Zudem dient die Stagingumgebung der Gewährleistung einer reibungslosen Funktionalität von Updates der FIT-Connect-Infrastruktur selbst, bevor diese auf der Produktivumgebung ausgerollt werden.<br/>**Zielgruppe**: Die Stagingumgebung steht ausschließlich Systemen zur Verfügung, die ebenfalls zum Zugriff auf die Produktivumgebung berechtigt sind.<br/>**Besonderheiten**: Die Nutzung der Stagingumgebung setzt den Einsatz von Zertifikaten aus der Verwaltungs-PKI voraus. | +| Produktivumgebung (`prod`) | **Zweck**: Die Produktivumgebung dient der produktiven Nutzung der FIT-Connect-Infrastruktur.<br/>**Zielgruppe**: Die Nutzung der Produktivumgebung ist Betreiber:innen vorbehalten, die entsprechende Nutzungsbedingungen unterzeichnet und einen Auftragsdatenverarbeitungsvertrag mit der FITKO abgeschlossen haben.<br/>**Besonderheiten**: Die Nutzung der Produktivumgebung setzt den Einsatz von Zertifikaten aus der Verwaltungs-PKI voraus. | + +## Testumgebung {#testing} + +Für Anbindungstests in der Testumgebung können Sie die folgenden Endpunkte & Infos verwenden: + +- [Self-Service-Portal](./account.mdx) der Testumgebung: [https://portal.auth-testing.fit-connect.fitko.dev](https://portal.auth-testing.fit-connect.fitko.dev) +- [OAuth Token URL](./authentication.mdx): `https://auth-testing.fit-connect.fitko.dev/token` +- [Submission API](../apis/submission-api.mdx): `https://submission-api-testing.fit-connect.fitko.dev` +- [Routing API](../apis/routing-api.mdx): `https://routing-api-testing.fit-connect.fitko.dev` + +## Staging-Umgebung {#staging} + +Für Integrationstests in der Staging-Umgebung, auch Referenz-Umgebung genannt, können Sie die folgenden Endpunkte & Infos verwenden: + +- [Self-Service-Portal](./account.mdx) der Staging-Umgebung: [https://portal.auth-refz.fit-connect.fitko.net](https://portal.auth-refz.fit-connect.fitko.net) +- [OAuth Token URL](./authentication.mdx): `https://auth-refz.fit-connect.fitko.net/token` +- [Submission API](../apis/submission-api.mdx): `https://submission-api-refz.fit-connect.niedersachsen.de` +- [Routing API](../apis/routing-api.mdx): In der Staging-Umgebung steht keine eigene Routing-API zur Verfügung. Bitte nutzen Sie für Integrationstests stattdessen die Routing-API der Produktivumgebung. + +## Produktivumgebung {#prod} + +Für eine Anbindung in der Produktivumgebung können Sie die folgenden Endpunkte & Infos verwenden: + +- [Self-Service-Portal](./account.mdx) der Produktivumgebung: [https://portal.auth-prod.fit-connect.fitko.net](https://portal.auth-prod.fit-connect.fitko.net) +- [OAuth Token URL](./authentication.mdx): `https://auth-prod.fit-connect.fitko.net/token` +- [Submission API](../apis/submission-api.mdx): `https://submission-api-prod.fit-connect.niedersachsen.de` +- [Routing API](../apis/routing-api.mdx): `https://routing-api-prod.fit-connect.fitko.net` + diff --git a/docs/getting-started/get-started.mdx b/docs/getting-started/get-started.mdx index 45cd5358d493d2e4bcefd00ff2a1fe7a9dedfae6..13a0d2ace20f8ccdf611fc027dca3fbeaa2524f4 100644 --- a/docs/getting-started/get-started.mdx +++ b/docs/getting-started/get-started.mdx @@ -18,30 +18,10 @@ Auf den folgenden Seiten stellen wir Code-Beispiele für die Anbindung von IT-Sy ::: ## Betriebsumgebungen der FIT-Connect-Infrastruktur {#environments} +Eine Übersicht über die Betriebsumgebungen der FIT-Connect-Infrastruktur findet sich im Artikel [Betriebsumgebungen](./environments.mdx). -### Übersicht -Für FIT-Connect stehen derzeit mehrere Betriebsumgebungen bereit, die jeweils einen etwas anderen Zweck erfüllen. -Umgebungen, die von der FITKO zu Test- und Entwicklungszwecken bereitgestellt werden, stehen unter einer Subdomain unterhalb von `fitko.dev` zur Verfügung. -Produktive und produktivnahe Umgebungen stehen unter einer Subdomain unterhalb von `fitko.net` (bzw. unterhalb von `niedersachsen.de` für die bei IT.Niedersachsen betriebenen Infrastrukturen) zur Verfügung. - -| Umgebung | Zweck und Zielgruppe | -| ---------------------------------- | -------------------- | -| Testumgebung (`testing`) | **Zweck**: Die Testumgebung dient vorrangig Anbindungstests und der Erprobung neuer Features.<br/>**Zielgruppe**: Die Testumgebung steht allen Interessierten zur freien Nutzung zur Verfügung, darf nicht für produktive Zwecke genutzt werden und unterliegt keinerlei Verfügbarkeitsgarantien.<br/>**Besonderheiten**: In der Testumgebung können selbst-generierte Test-Zertifikate anstelle von Zertifikaten aus einer PKI-Infrastruktur genutzt werden. | -| Staging-/Referenzumgebung (`refz`) | **Zweck**: Die Stagingumgebung, auch Referenzumgebung genannt, ist identisch zur Produktivumgebung konfiguriert und dient dem Test von Updates der an FIT-Connect angebundenen Systeme, bevor diese an die Produktivumgebung angebunden werden. Zudem dient die Stagingumgebung der Gewährleistung einer reibungslosen Funktionalität von Updates der FIT-Connect-Infrastruktur selbst, bevor diese auf der Produktivumgebung ausgerollt werden.<br/>**Zielgruppe**: Die Stagingumgebung steht ausschließlich Systemen zur Verfügung, die ebenfalls zum Zugriff auf die Produktivumgebung berechtigt sind.<br/>**Besonderheiten**: Die Nutzung der Stagingumgebung setzt den Einsatz von Zertifikaten aus der Verwaltungs-PKI voraus. | -| Produktivumgebung (`prod`) | **Zweck**: Die Produktivumgebung dient der produktiven Nutzung der FIT-Connect-Infrastruktur.<br/>**Zielgruppe**: Die Nutzung der Produktivumgebung ist Betreiber:innen vorbehalten, die entsprechende Nutzungsbedingungen unterzeichnet und einen Auftragsdatenverarbeitungsvertrag mit der FITKO abgeschlossen haben.<br/>**Besonderheiten**: Die Nutzung der Produktivumgebung setzt den Einsatz von Zertifikaten aus der Verwaltungs-PKI voraus. | - -### Testumgebung {#testing} - -Für Anbindungstests in der Testumgebung können Sie die folgenden Endpunkte & Infos verwenden: - -- Self-Service-Portal der Testumgebung: siehe [Accountregistrierung und Client-Verwaltung](./account.mdx) -- [OAuth Token URL](./authentication.mdx): `https://auth-testing.fit-connect.fitko.dev/token` -- [Submission API](../apis/submission-api.mdx): `https://submission-api-testing.fit-connect.fitko.dev` -- [Routing API](../apis/routing-api.mdx): `https://routing-api-testing.fit-connect.fitko.dev` - -<br/> - +## Newsletter :::note Newsletter -Bleiben Sie auf dem neusten Stand. <br/> +Bleiben Sie auf dem neusten Stand.<br/> Unser [Newsletter](../contact/newsletter.mdx) informiert Sie über neue Releases von FIT-Connect, neue Features und sicherheitsrelevante Themen, siehe [Newsletter Abonnement](../contact/newsletter.mdx). ::: diff --git a/docs/receiving/download-submission.mdx b/docs/receiving/download-submission.mdx index 0fd8b8b1f45b7edb5789814de4d5f2a6ccdbdff9..31ffe7df749b5a73aab77418c4d28cc21001ceba 100644 --- a/docs/receiving/download-submission.mdx +++ b/docs/receiving/download-submission.mdx @@ -8,7 +8,7 @@ import ApiLink from '@site/src/components/ApiLink' Der Abruf einer Einreichung ist über den Endpunkt <ApiLink api="submission-api" 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). Einreichungen und deren Anlagen können dabei nur im Status Submitted oder Forwarded abgerufen werden. :::note Hinweis -Die URL der Submission API findet sich im Artikel [Erste Schritte](../getting-started/get-started.mdx#testing). +Die URL der Submission API findet sich im Artikel [Betriebsumgebungen](../getting-started/environments.mdx#testing). ::: ```bash title="Abfrage der Einreichung inkl. Fachdaten und Metadaten" diff --git a/docs/sending/get-destination.mdx b/docs/sending/get-destination.mdx index 2893295f4b834b1b3fccb348166d1f3329de558d..42e7cadd19bef9e60a776b2ef55f4b606da03572 100644 --- a/docs/sending/get-destination.mdx +++ b/docs/sending/get-destination.mdx @@ -534,7 +534,7 @@ Beispiel für die Response 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. Diese kann genutzt werden, wenn die `destinationId` bereits bekannt ist. Die angebotenen Informationen über eine Destination unterscheiden sich fachlich nicht von den Information aus der Routing API. Bei der Submission API muss lediglich der Verschlüsselungsschlüssel über einen zusätzlichen Endpunkt abgerufen werden, anstatt diesen zusammen mit den anderen Informationen in einer Response zu erhalten (siehe Artikel [Verschlüsseln](../sending/encrypt.mdx)). :::note Hinweis -Die URL der Submission API findet sich im Artikel [Erste Schritte](../getting-started/get-started.mdx#testing). +Die URL der Submission API findet sich im Artikel [Betriebsumgebungen](../getting-started/environments.mdx#testing). ::: <Tabs diff --git a/docs/sending/start-submission.mdx b/docs/sending/start-submission.mdx index 4766ee6d54ac2565a1274802b7d8c62ce7a54991..ed4972de0fcbc11019bb671012748a167a302a53 100644 --- a/docs/sending/start-submission.mdx +++ b/docs/sending/start-submission.mdx @@ -29,7 +29,7 @@ Die für das Anlegen von Einreichungen notwendige Struktur von Einreichungen und ::: :::note Hinweis -Die URL der Submission API findet sich im Artikel [Erste Schritte](../getting-started/get-started.mdx#testing). +Die URL der Submission API findet sich im Artikel [Betriebsumgebungen](../getting-started/environments.mdx#testing). ::: diff --git a/sidebar.js b/sidebar.js index 02cd7712fef8fa9b469e829d6285a89bef90a62f..b8f0c5597931f9ba1f5bfd44434da1f908ab7f75 100644 --- a/sidebar.js +++ b/sidebar.js @@ -50,6 +50,7 @@ module.exports = { 'leitfaeden/integration-guide-subscriber', ] }, + 'getting-started/environments', 'getting-started/account', 'getting-started/authentication', {