Clearing Spezifikation

Die Spezifikation der Schnittstelle für die Clearing-Plattformen wurde vom Arbeitskreis Schnittstellen & Prozesse seit Sommer 2021 mit einer Reihe von Dienstleistern erarbeitet. Sie basiert auf zeitgemäßen technischen Standards auf Basis von REST-Schnittstellen und den Leitlinien des Tele Management-Forums (TMF).

Clearing Plattform Spezifikation (initiale Version 1.0 vom September 2022)

Im vorliegenden Paket (Zip File) sind folgende Dokumente enthalten:

• Clearing Platform REST API Specification V1.0 (PDF)
  Dieses ist das Kerndokument, welches die Funktionalität der Schnittstelle definiert (angelehnt an die Trouble Ticket REST API Specification TMF621)
• Clearing Platform non functional requirements V1.0 (PDF)
  Die Spezifikation der nichtfunktionalen Anforderungen an die Plattformen (Sicherheit, Datenschutz u.a.)
• Clearing_Platform_OpenAPI_ Specification _V1 (YAML)
  Diese maschinenlesbare YAML-Datei (auch wandelbar in ein JSON-Format) spezifiziert die Schnittstelle in technischer Hinsicht.
• Clearing_Platform_Metadata (im YAML und in XLS-Format)
  Dies ist das technische Validierungs-Schema, das die zahlreichen fachlich abgeleiteten Felder beschreibt (z.B. Clearingszenarien, Verwendung von Feldern in Abhängigkeit vom Szenario, Pflichtfelder und anderes). Es handelt sich um ein Dokumentenpaar: es ist im YAML-Format maschinenlesbar, während die XLS-Datei eine inhaltsgleiche, aber besser menschenlesbare Version davon bereitstellt. Weiterhin beschreibt und dokumentiert die Datei Clearing_Platform_Metadata_Schema.YAML dieses Schema.
• ein sog. „Usage Guide“ (englischsprachig, Zielgruppe Developer), der ebenfalls noch in Erarbeitung ist. Der Usage Guide beschreibt, wie die Clearing Platform API vor dem
  Hintergrund des fachlichen Kontextes zu verstehen und zu verwenden ist. (derzeit in DRAFT-Version)