Spezifikation von Clearing-Schnittstellen
Schnittstellenspezifkation 1.1 (September 2023)
Die erste Version 1.0 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).
Nach Veröffentlichung der Version 1.0 haben einige Telekommunikationsunternehmen die praktische Anwendung der Schnittstelle verprobt und die daraus gesammelten Erfahrungen aus den Piloten sind nun in die Version 1.1. eingeflossen. Das grundlegende technischen Konzept für das Clearing wurde hierbei nicht verändert, die Änderungen wirken insbesondere auf die fachliche Nutzung der von den Dienstleistern betriebenen Clearing Plattformen.
Die Änderungen umfassen hierbei insbesondere:
- Erweiterung der Metadaten, um fachlich relevante Attribute
- Review von Pflichtfeldern
- Erweiterung der nutzbaren Clearingszenarien
Unterlagen zur Spezifikation 1.1
Main 1 – Clearing Platform REST API Specification (Version 1.1. vom September 2023)
Dieses ist das Kerndokument, welches die Funktionalität der Schnittstelle definiert (angelehnt an die Trouble Ticket REST API Specification TMF621)
REF-1 – Clearing Platform non functional requirements (V1.0 unverändert vom September 2022)
Die Spezifikation der nicht funktionalen Anforderungen an die Plattformen (Sicherheit, Datenschutz u.a.)
REF-2 – Clearing Platform Open API_ Specification (Version 1.1. vom September 2023)
Diese maschinenlesbare YAML-Datei (auch wandelbar in ein JSON-Format) spezifiziert die Schnittstelle in technischer Hinsicht.
REF-3 (XLSX) – Clearing Platform Metadata (Version 1.1. vom September 2023)
REF-4 (YAML) – Clearing Platform Metadata (Version 1.1. vom September 2023) D
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 (REF-3) eine inhaltsgleiche, aber besser menschenlesbare Version davon bereitstellt. Weiterhin beschreibt und dokumentiert die Datei Clearing_Platform_Metadata_Schema (REF-5) dieses Schema.
REF-5 Clearing Platform Metadata Schema (Version 1.1. vom September 2023)
Die YAML Dateien werden als ZIP File zur Verfügung gestellt
