Zum Hauptinhalt springen

Bibliotheken-Dokumentation

Die DVDV-Bibliotheken (für Java™ bzw. .NET) verbergen die Web-Schnittstelle des DVDV-Servers hinter einer typsicheren Progammierschnittstelle und ermöglichen außerdem im Falle des Ausfalls eines DVDV-Servers ein transparentes Failover zu einem Vertretungs-DVDV-Server.

Die Authentifizierung erfolgt dabei entweder am IAM/Keycloak oder direkt am DVDV-Server mittels zertifikatbasierter Authentifizierung. Für rechenzentrumsinterne Zugriffe wird auch eine Schnittstelle ohne Authentifizierung angeboten.

Fachliche Funktionalität​

Die fachlichen Methoden, die der DVDV-Server und damit auch die beiden Bibliotheken bieten, sind folgende:

  • findOrganizationDescription - Suche nach einer Organisation oder einem Stellvertreter;
    Vergleichbar zur Methode findAuthorityDesctiption aus DVDV1.
    Eingabeparameter: Organisationsschlüssel, Kategorie der Organisation
    Rückgabewert: Die einzige zu den Eingabewerten passende Organisation (inklusive aller ihrer Dienste und Stellvertreter), falls es eine solche gibt.
  • findAuthorityDesctiption - funktionsgleich zu findOrganizationDescription
  • findServiceDescription - Suche nach einem Dienst zu einer Organisation
    Vergleichbar zur entsprechenden Methode aus DVDV1.
    Eingabeparameter: Organisationsschlüssel, URI der Dienstspezifikation
    Rückgabewert: Der einzige zu den Eingabewerten passende und zum Zeitpunkt des Aufrufs gültige Dienst, falls es einen solchen gibt.
  • verifyCategory - Suche nach einer Organisation oder einem Stellvertreter
    Vergleichbar zur entsprechenden Methode aus DVDV1.
    Eingabeparameter: Kategorie der Organisation, Fingerprint eines Client-Zertifikates
    Rückgabewert: true, wenn zu dem Zertifikat eine Organisation der entsprechenden Kategorie existiert, false sonst
  • findCategories - Ermittlung der Kategorie(n) einer Organisation oder eines Stellvertreters Eingabeparameter: Organisationsschlüssel, Fingerprint eines Client-Zertifikates
    Rückgabewert: Liste der Kategorien derjenigen Organisationen, die den angegebenen Schlüssel und das angebene Client-Zertfifikat haben. (Davon gibt es i.d.R. nur höchstens eine.)
  • findOrganizationsByServiceElement - Suche von Organisationen anhand bestimmter Eigenschaften eines ihrer Dienstelemente.
    Eingabeparameter: Dienstelementtyp sowie und ein weiterer Suchparameter, gegeben durch Typ und Wert
    Rückgabewert: Liste derjenigen Organisationen, die ein Dienstelementzertifikat von angegeben Dienstelementtyp haben, das außerdem das mit den Suchparameter angegeben Kriterium erfüllt.
  • FindCertificateByFingerprint - Suche nach einem Zertifikat anhand eines Fingerprint
    Eingabeparameter: Fingerprint eines Zertifikates
    Rückgabewert: Das Zertifikat mit dem angegebenen Fingerprint, wenn es in der DVDV-Datenbank hinterlegt ist.
  • getIntermediaries - Liste der Intermediäre
    Eingabeparameter: keine
    Rückgabewert: Liste aller im DVDV hinterlegten der Intermediäre
  • getCategories - Kategorienbaum
    Eingabeparameter: keine
    Rückgabewert: Alle im DVDV hinterlegten der Kategorien inklusive ihrer hierarischen Beziehung
  • findServiceSpecificationUrisByCategory - Liste aller Werte von Dienstbeschreibungs-URIs von solchen Dienstbeschreibungen, die eine Organisation anbieten darf, wenn sie die angegebene Kategorie hat.
    Eingabeparameter: Kategorie, z.B. 'Meldebehörde'.

Die o.a. Methoden sind, sofern sinnvoll, überladen mit einer sogenannten "batch-Variante". Mit der jeweiligen batch-Variante erhalten Sie die Rückgabewerte von mehreren Einzelmethodenaufrufen mit einem einzelnen HTTP(S)-Request.

Falls Sie mit Java™ entwickeln, finden Sie hier die Java-Schnittstellendokumentation sowie die Änderungshistorie.

Falls Sie mit .NET entwickeln, finden Sie hier die .NET-Schnittstellendokumentation sowie die Änderungshistorie.

Falls Sie keine der Bibliotheken nutzen können, können Sie die Web-Schnittstelle des DVDV-Servers direkt nutzen.