tanzsport/esv-api-client

ESV API-Client Tanzsport Deutschland

1.0 2023-10-06 06:46 UTC

Requires

• php: >= 7.4
• guzzlehttp/guzzle: ^7.4
• jms/serializer: ^3.17
• psr/cache: ^1.0.1

Requires (Dev)

• mockery/mockery: ^1.5
• phpunit/phpunit: ^9.5

MIT

• Hendrik Heneke

README

Installation

1. Composer installieren falls noch nicht vorhanden:

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

2. Im Wurzelverzeichnis des eigenen Projektes eine neue Composer-Abhängigkeit installieren:

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

3. Die Einbindung in das eigene Projekt erfolgt über den Composer-Autoloader:

    require_once 'vendor/autoload.php';
   

Parameter

Für die tatsächliche Verwendung des Clients sind erforderlich:

• API-Token
• Benutzername
• Passwort

Initialisierung

Zunächst muss ein Endpunkt definiert werden:

$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.

Tanzsport\ESV\API\Client ist die zentrale Klasse, über die der Client initialisiert wird:

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

Der User-Agent kann frei gewählt werden, sollte aber sprechend sein.

Operationen

Abfrage von Einzelstartern

Einzelstarter können anhand Ihrer DTV-ID oder WDSF-MIN abgefragt werden:

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