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). :::