Was bietet die API des Validation Service?

Sie erfahren, wie unser Validation Service Ihnen sowohl fachlich als auch technisch dabei hilft, die Daten aus diversen Branchen zu validieren.

Inhaltsverzeichnis

    Vorteile des Validation Service der GET AG

    Der Validation Service aus der GET AG Service Cloud validiert Daten aus verschiedenen Branchen, damit Ihre Prozesse automatisiert und die Datenqualität erhöht werden können. Weitere Vorteile im Überblick:

    • ein Ansprechpartner für unterschiedlichste Validierungen aus diversen Quellen
    • zentralisierte Bereitstellung von Validierungen für Anwendungsfälle aus diversen Branchen in einer API
    • laufende Erweiterung der API um neue Validierungen - sprechen Sie uns auch bei eigenen Erweiterungswünschen gern an!
    • hohe Skalierbarkeit durch Hosting bei Amazon Web Services (AWS)
    • eine deutschsprachige API Doku auch bei fremdsprachigen Datenquellen
    • unkomplizierte Beantragung eines kostenlosen Testzugangs über das unten stehende Kontaktformular

    Fachliche Dokumentation der Validierungen

    Validierung Telefonnummer

    Der phone-Endpunkt des Validation Service /api/v1/phone/valid analysiert die Struktur von Telefonnummern, und verfügt über folgende Funktionalitäten:

    • Validierung gängiger Vorwahlen anhand von aktuell veröffentlichten Daten der Bundesnetzagentur und Rückgabe der einzelnen Nummernbestandteile
    • Umformatierung der Telefonnummer gemäß DIN 5008 und Rückgabe als Gesamt-String
    • Rückgabe von boolean Status-Parametern mit weiterführenden Validierungen zur Art der Telefonnummer

    Generelle Struktur:

    Ländervorwahl VorwahlRufnummer
    Vorwahl” ist hier als Sammelbegriff zu verstehen, der bspw. bei deutschen Telefonnummern eine Orts-, Mobilfunk- oder Sondervorwahl sein kann.

    Übersetzung analog:

    Country PrefixArea CodeLine Number

     

    Beispielhafte Eingabe-Schreibweisen:

    0049-341-1234567
    +49-(0)341-1234567
    0341-1234567
    (0341)(1234-567)

     

    Ergebnisobjekt:

    Status-booleans der Validierung:

    • isValidCountryPrefix (valide Ländervorwahl)
    • isValidAreaCode (valide deutsche Festnetz-/Mobil- oder Sondervorwahl)
    • isValidPhoneLineNumberLength (valide Mindestlänge Rufnummer)
    • isValid (nur dann "true", wenn die vorherigen drei isValid...-Parameter allesamt "true" sind)

    Für deutsche Vorwahlen gibt es außerdem Validierungen der Art der Vorwahl:

    • isFixedLine (Vorwahl ist eine Ortsvorwahl/Festnetz)
    • isMobileNumber (Vorwahl ist eine Mobilfunkvorwahl)
    • isSpecialNumber (Vorwahl ist eine Sonderufnummernvorwahl)

    Komponenten der Telefonnummer:

    • phoneCountryPrefix (Ländervorwahl), nullable
    • countryCode (2-Letter-Ländercode der identifizierten Ländervorwahl gemäß ISO 3166 alpha 2), nullable
    • countryName (Bezeichnung des Landes zur Ländervorwahl in englisch), nullable
    • phoneAreaCode (Orts-/Festnetz-/Mobilfunk- oder Sondervorwahl bei deutschen Telefonnummern), nullable
    • phoneAreaName (indikative Bezeichnung/Zusatzinformation zur Vorwahl), nullable
    • phoneLineNumber (Rufnummer bzw. sämtliche nicht-identifizierten Telefonnummernteile), nicht nullable
    • phoneNumber (komplette Telefonnummer, möglichst nah am DIN 5008 Format, bereinigt von allen Sonderzeichen außer, ggf., dem „+“), nicht nullable

    ⚠️Wichtig: Der Parameter phoneAreaName enthält bei identifizierter Ortsvorwahl nur den Namen des Hauptortes, der zu dieser Ortsvorwahl gehört und erlaubt damit keine zuverlässige Zuordnung bspw. in dünn besiedelten Gebieten. 

    Validierung Marktlokations-Identifikationsnummer (MaLo-ID)

    Die Marktlokationen aus der Energiewirtschaft im Strom- und Gasbereich werden über den Endpunkt /api/v2/malo/actions/valid/number folgendermaßen validiert:

    • BDEW Prüfziffernberechnung nach „Lok- and Waggon-Kennzeichnungsverfahren“
    • Prüfung auf 11 Stellen
    • Prüfung auf ausschließliche Eingabe von Ziffern

    Die API wird ab dem 06.06.2025 im Zuge des 24 h Lieferantenwechsels Strom benötigt, um die verpflichtend anzugebende Marktlokation (MaLo-ID) in Tarifrechnern / Abschlusstrecken zu validieren.

    Technische Dokumentation - SwaggerUI und OpenAPI Beschreibung

    Zugangsdaten

    Die Zugangsdaten haben Sie entweder in einer E-Mail vom GET AG Support erhalten oder können einen Zugang mit unten stehenden Kontaktformular beantragen.

    URL Validation Service

    Sie erreichen die SwaggerUI des Validation Service mit folgenden URL:

    Testsystem: https://test.validation-service.getag-cloud.com/swagger-ui/index.html

    Produktivsystem: https://validation-service.getag-cloud.com/swagger-ui/index.html

    Cliententwicklung - Hinweise für Softwareentwickler

    Tipps für Softwareentwickler zur Clientgenerierung aus der OpenAPI Beschreibung gibt es hier. Darüberhinaus empfehlen wir die technische Dokumentation zu lesen.

    Kontaktformular

    Haben Sie Fragen zur API des Validation Service oder möchten ein Angebot erhalten oder einen Testzugang beantragen, dann nutzen sie bitte unser Kontaktformular: