submission-api.yaml

openapi: 3.1.0

info:
  version: 'API_VERSION'
  title: Submission API
  description: >
    Die FIT-Connect Submission API ermöglicht das Einreichen von Anträgen und Berichten aus vorgelagerten Systemen (z. B. Onlineantragsdiensten, Fachportalen oder Berichtssystemen) an die Systeme der Verwaltung zur elektronischen Verfahrensbearbeitung (z. B. Fachverfahren, Dokumentenmanagementsysteme oder Prozessplattformen).
  contact:
    name: FITKO
    url: https://docs.fitko.de/fit-connect/contact
  license:
    url: 'https://creativecommons.org/licenses/by-sa/4.0/'
    name: Creative Commons Attribution Share Alike 4.0 (CC BY-SA 4.0)
  termsOfService: https://docs.fitko.de/fit-connect/docs/details/terms-of-use-testing/

servers:
  - url: 'https://submission-api-testing.fit-connect.fitko.dev'
    description: "FIT-Connect Testumgebung"

externalDocs:
  description: FIT-Connect-Dokumentationsportal mit Dokumentation zur API-Nutzung
  url: https://docs.fitko.de/fit-connect

tags:
  - name: Einreichungsübermittlung
    description: Diese Gruppe enthält alle Endpunkte, die für das Versenden von Einreichungen an einen Zustellpunkt notwendig sind.
    externalDocs:
      url: https://docs.fitko.de/fit-connect/docs/getting-started/sending/overview
  - name: Einreichungsempfang
    description: Diese Gruppe umfasst alle Endpunkte, die für den Empfang und die Abfrage von Einreichungen notwendig sind.
    externalDocs:
      url: https://docs.fitko.de/fit-connect/docs/getting-started/receiving/overview
  - name: Antwort senden
    description: Diese Gruppe umfasst alle Endpunkte für das Versenden von Antworten auf Einreichungen.
  - name: Antwort empfangen
    description: Diese Gruppe umfasst alle Endpunkte für das Empfangen von Antworten auf Einreichungen.
  - name: Fachlich
    description: Unter dieser Gruppe sind alle Endpunkte organisiert, die fachliche Informationen über die Instanz des Zustelldienstes liefern.
  - name: Internal
    description: Unter dieser Gruppe werden Endpunkte gelistet, die FIT-Connect intern sind und API-Clients nicht zur Verfügung stehen.
  - name: Vorgangsverwaltung
    description: Unter dieser Gruppe sind alle Endpunkte organisiert, die sich auf einen Vorgang (Case) in beziehen.
  - name: Webhooks
    description: Webhooks (Callbacks), über die FIT-Connect sendende und empfangende Systeme über Ereignisse benachrichtigt.
paths:
  /v1/destinations/{destinationId}:
    $ref: './endpoints/destinations/uuid.yaml'

  /v1/destinations/{destinationId}/keys/{keyId}:
    $ref: './endpoints/destinations/keys/uuid.yaml'

  /v1/cases/{caseId}/events:
    $ref: './endpoints/cases/events/index.yaml'

  /v1/cases/{caseId}:
    $ref: './endpoints/cases/uuid.yaml'

  /v1/cases:
    $ref: './endpoints/cases/index.yaml'

  /v1/replies:
    $ref: './endpoints/replies/index.yaml'

  /v1/replies/{replyId}:
    $ref: './endpoints/replies/uuid.yaml'

  /v1/replies/{replyId}/accept:
    $ref: './endpoints/replies/accept/uuid.yaml'

  /v1/replies/{replyId}/reject:
    $ref: './endpoints/replies/reject/uuid.yaml'

  /v1/replies/{replyId}/attachments/{attachmentId}:
    $ref: './endpoints/replies/attachments/uuid.yaml'

  /v1/replies/{replyId}/events:
    $ref: './endpoints/replies/events/index.yaml'

  /v1/submissions:
    $ref: './endpoints/submissions/index.yaml'

  /v1/submissions/{submissionId}:
    $ref: './endpoints/submissions/uuid.yaml'

  /v1/submissions/{submissionId}/attachments/{attachmentId}:
    $ref: './endpoints/attachments/uuid.yaml'

  /v1/submissions/{submissionId}/events:
    $ref: './endpoints/submissions/events/index.yaml'

  /v1/info:
    $ref: './endpoints/info/index.yaml'

  /.well-known/jwks.json:
    $ref: './endpoints/well-known/jwks.json/index.yaml'

webhooks:
  new-events:
    $ref: './webhooks/new-events.yaml'
  new-replies:
    $ref: './webhooks/new-replies.yaml'
  new-submissions:
    $ref: './webhooks/new-submissions.yaml'

components:
  securitySchemes:
    OAuth2:
      $ref: './security/oauth2.yaml'
    InternalOAuth2:
      $ref: './security/internal-oauth2.yaml'