Skip to content
Snippets Groups Projects
Commit c20b145a authored by Marco Holz's avatar Marco Holz
Browse files

Merge branch 'mr-improve-structure' into 'main'

Verbesserungen an der Inhaltsstruktur

See merge request !18
parents c01cf2a6 425a59db
No related branches found
No related tags found
1 merge request!18Verbesserungen an der Inhaltsstruktur
...@@ -5,6 +5,10 @@ import TabItem from '@theme/TabItem' ...@@ -5,6 +5,10 @@ import TabItem from '@theme/TabItem'
Nachfolgend wird der Abruf von Access Tokens beim OAuth-Dienst sowie der Zugriff auf die FIT-Connect Submission API mittels Access Tokens beschrieben. Nachfolgend wird der Abruf von Access Tokens beim OAuth-Dienst sowie der Zugriff auf die FIT-Connect Submission API mittels Access Tokens beschrieben.
:::note Hinweis
Als Voraussetzungen hierfür ist es notwendig, Accounts für [API-Clients im Self-Service-Portal zu registrieren](../account.mdx).
:::
## Abruf von Access Tokens beim OAuth-Dienst ## Abruf von Access Tokens beim OAuth-Dienst
Fast alle Anfragen an die FIT-Connect Submission API müssen authentifiziert werden. Fast alle Anfragen an die FIT-Connect Submission API müssen authentifiziert werden.
......
# Überblick # Erste Schritte
Im folgenden "Getting Started"-Guide wird beschrieben, wie die ersten Interaktionen mit FIT-Connect ablaufen und FIT-Connect integriert werden kann. Im folgenden "Getting Started"-Guide wird beschrieben, wie die ersten Interaktionen mit FIT-Connect ablaufen und FIT-Connect integriert werden kann.
In den nächsten Abschnitten wird beschrieben, wie man sich gegenüber FIT-Connect authentifiziert, Daten für die Übertragung ver- und entschlüsselt werden, sowie welche Schritte für das Einreichen bzw. Empfangen von Einreichungen notwendig sind. In den nächsten Abschnitten wird beschrieben, wie man sich [gegenüber FIT-Connect authentifiziert](./authentication), Daten für die Übertragung [ver- und entschlüsselt](./encryption) werden, sowie welche Schritte für das [Einreichen](./sending/overview) bzw. [Empfangen](./receiving/overview) von Einreichungen notwendig sind.
:::note Hinweis :::note Zielgruppe
Als Voraussetzungen hierfür ist es notwendig einen Account zu besitzen, wie in "[Registrierung und Account-Verwaltung](../account.mdx)" beschrieben ist. Die folgenden Seiten beinhalten teils sehr technische Detailinformationen zur Umsetzung einer Anbindung an die FIT-Connect-Schnittstellen. Zielgruppe der folgenden Seiten sind vorangig Entwickler:innen.
::: :::
Kern von FIT-Connect ist der Zustelldienst, der sendende und empfangende Systeme einer Einreichung verbindet. Kern von FIT-Connect ist der Zustelldienst, der sendende und empfangende Systeme einer Einreichung verbindet.
......
File moved
...@@ -107,7 +107,7 @@ Entwickler ihre Anwendungen das Self-Service-Portal vorab registrieren. Projektp ...@@ -107,7 +107,7 @@ Entwickler ihre Anwendungen das Self-Service-Portal vorab registrieren. Projektp
für produktive Datenübermittlungen ab September 2020 nutzen. Detailerte Zeitpläne können der [Roadmap](https://docs.fitko.de/fit-connect/docs/roadmap) für produktive Datenübermittlungen ab September 2020 nutzen. Detailerte Zeitpläne können der [Roadmap](https://docs.fitko.de/fit-connect/docs/roadmap)
entnommen werden. Updates werden regelmäßig im Bereich [News](https://docs.fitko.de/fit-connect/news) mitgeteilt. entnommen werden. Updates werden regelmäßig im Bereich [News](https://docs.fitko.de/fit-connect/news) mitgeteilt.
## Ich habe einen Fehler in der Dokumentation oder in der API-Spezifikation gefunden. Wo kann ich diesen melden? ## Ich habe einen Fehler in der Dokumentation oder in der API-Spezifikation gefunden. Wo kann ich diesen melden? {#found-bug}
Vielen Dank für das Interesse an unserer Entwickler:innendokumentation! Wir freuen uns immer über Feedback und Vielen Dank für das Interesse an unserer Entwickler:innendokumentation! Wir freuen uns immer über Feedback und
Anregungen über unser Funktionspostfach fit-connect ät fitko.de. Zudem können wir bei Interesse gerne einen Zugang zu Anregungen über unser Funktionspostfach fit-connect ät fitko.de. Zudem können wir bei Interesse gerne einen Zugang zu
......
...@@ -25,7 +25,7 @@ Wir nehmen gerne neue Wünsche & Anregungen für die FIT-Connect API als Issue a ...@@ -25,7 +25,7 @@ Wir nehmen gerne neue Wünsche & Anregungen für die FIT-Connect API als Issue a
Projekt (https://git.fitko.de/fit-connect/api) entgegen und versuche diese Issues nach einer Umsetzungsprüfung in unsere Projekt (https://git.fitko.de/fit-connect/api) entgegen und versuche diese Issues nach einer Umsetzungsprüfung in unsere
Roadmap aufzunehmen. Roadmap aufzunehmen.
> Wünsche & Anregungen oder Fehler können über den [hier](overview.md#ich-habe-einen-fehler-in-der-dokumentation-oder-in-der-api-spezifikation-gefunden-wo-kann-ich-diesen-melden) beschriebenen Prozess abgegeben werden können. > Wünsche & Anregungen oder Fehler können über den [hier](intro.md#found-bug) beschriebenen Prozess abgegeben werden können.
## Überblick über die Zeitplanung ## Überblick über die Zeitplanung
......
...@@ -11,9 +11,10 @@ ...@@ -11,9 +11,10 @@
module.exports = { module.exports = {
defaultSidebar: [ defaultSidebar: [
'overview', 'intro',
'roadmap', 'roadmap',
'changelog', 'changelog',
'glossary',
'account', 'account',
'status-and-error-codes', 'status-and-error-codes',
/*{ /*{
...@@ -101,16 +102,9 @@ module.exports = { ...@@ -101,16 +102,9 @@ module.exports = {
], ],
}, },
{ {
type: 'category', type: 'link',
label: 'Weiteres', label: 'Impressum',
items: [ href: 'https://www.fitko.de/Impressum',
'more/glossary',
{
type: 'link',
label: 'Impressum',
href: 'https://www.fitko.de/Impressum',
},
],
}, },
], ],
} }
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment