tanzsport/esv-api-client

ESV API-Client Tanzsport Deutschland

ESV-Client PHP

Installation

1. Composer installieren falls noch nicht vorhanden:, _(*1)

   curl -s http://getcomposer.org/installer | php

2. Im Wurzelverzeichnis des eigenen Projektes eine neue Composer-Abhängigkeit installieren:, _(*2)

   composer require "tanzsport/esv-api-client" "dev-master"

3. Die Einbindung in das eigene Projekt erfolgt über den Composer-Autoloader:, _(*3)

   require_once 'vendor/autoload.php';

Parameter

Für die tatsächliche Verwendung des Clients sind erforderlich:, _(*4)

• API-Token
• Benutzername
• Passwort

Initialisierung

Zunächst muss ein Endpunkt definiert werden:, _(*5)

$endpunkt = new \Tanzsport\ESV\API\Endpunkt("http://...");

Der Endpunkt wird mit der Basis-URL für alle Zugriffe initialisiert, die frei eingegeben werden kann. Alternativ können die Klassenkonstanten Q1, Q2, PROD für die unterschiedlichen Umgebungen verwendet werden., _(*6)

Tanzsport\ESV\API\Client ist die zentrale Klasse, über die der Client initialisiert wird:, _(*7)

$client = new \Tanzsport\ESV\API\Client($endpunkt, 'MyUserAgent', 'token', 'user', 'password');

Der User-Agent kann frei gewählt werden, sollte aber sprechend sein., _(*8)

Operationen

Abfrage von Einzelstartern

Einzelstarter können anhand Ihrer DTV-ID oder WDSF-MIN abgefragt werden:, _(*9)

$client->getStarterResource()->findeStarterNachDtvOderWdsfId('Einzel', 10000456);