diff --git a/docs/getting-started/authentication.mdx b/docs/getting-started/authentication.mdx index 31ad91de07a239928eb193e6ecd21c947f31fb0e..cd74b31a7b43851f65834cdb631197a38db7a3f4 100644 --- a/docs/getting-started/authentication.mdx +++ b/docs/getting-started/authentication.mdx @@ -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). +::: diff --git a/docs/getting-started/receiving/download-submission.mdx b/docs/getting-started/receiving/download-submission.mdx index 45b9804356a50dac8e9579d615c6ef76fa2004d7..721534fa177f9005e0e1cba8fb5c8b71229324e0 100644 --- a/docs/getting-started/receiving/download-submission.mdx +++ b/docs/getting-started/receiving/download-submission.mdx @@ -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). diff --git a/docs/getting-started/sending/get-destination.mdx b/docs/getting-started/sending/get-destination.mdx index ae8333096893df12072787eed888b3c08a7815c1..47e96518aeaf03fd2dffe4e2c5b678241cdf667c 100644 --- a/docs/getting-started/sending/get-destination.mdx +++ b/docs/getting-started/sending/get-destination.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={[ diff --git a/docs/getting-started/sending/start-submission.mdx b/docs/getting-started/sending/start-submission.mdx index a9f31943bdb9c6803cfe5976255ca50fa1b599e6..00cfd469f24774cf54af8f446f0276fce05f2dbc 100644 --- a/docs/getting-started/sending/start-submission.mdx +++ b/docs/getting-started/sending/start-submission.mdx @@ -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={[