DWZ-Schnittstelle // API

Beschreibung

Die Schnittstelle wurde im Backend komplett überarbeitet und erfordert nun eine Registrierung. Mehr dazu lesen Sie weiter unten.

Wenn Sie auf Ihren Webseiten DWZ-Listen anzeigen möchten, bietet sich die Nutzung unserer API (englisch: application programming interface, deutsch: Schnittstelle zur Anwendungsprogrammierung) an. Die API stellt die Daten im JSON-Format zur Verfügung. Wie Sie auf diese API zugreifen können, wird nachfolgend beschrieben.

Zugriffsantrag stellen

Zugriff auf DWZ-Listen mit PHP

Das nachfolgende PHP-Skript zeigt rudimentär den Zugriff auf die Schnittstelle:

<?php

// Bitte speichern Sie die Beispieldatei im UTF8-Format auf Ihrem Server ab!

$api_url = 'https://www.schachbund.de/bundles/contaodewis/api.php';
$api_value = '30052'; // Parameter value | Vereinsnummer, hier vom SV Berolina Mitte
$api_modul = 'verein'; // Parameter modul | verein = Vereinsliste zurückgeben; verband = Verbandsliste zurückgeben
$api_token = '1234567890abcdef'; // Parameter token | Den API-Schlüssel haben Sie per E-Mail erhalten

$daten = file_get_contents($api_url.'?modul='.$api_modul.'&value='.$api_value.'&token='.$api_token);

header("Content-type: application/json; charset=utf-8");
echo $daten;

// Daten in ein Array umwandeln, um damit weiterarbeiten zu können:
// $array = json_decode($daten);
Beispielausgabe der API
Beispielausgabe der API

Mit dem obigen PHP-Code (natürlich mit dem richtigen Token) erhalten Sie die nebenstehende Ausgabe. Es wird ein assoziatives Array mit drei Einträgen error, status und data zurückgegeben:

  • error: true oder false
  • status: Wenn error = true, dann steht hier die Fehlermeldung
  • data: Das Array mit den angeforderten Daten

Wichtiger Hinweis

Die Nutzung der neuen Schnittstelle (gültig ab 06.03.2025) wird dringend empfohlen! Die alte Schnittstelle bleibt noch für eine Übergangszeit von maximal einigen Monaten online.