sailing-cz/api-client

Sailing.cz API client library

0.1.2 2024-12-07 20:56 UTC

Requires

• php: >= 8.0
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• ext-openssl: *
• guzzlehttp/guzzle: >= 7.5
• nette/utils: >= 3

Requires (Dev)

• nette/tester: >= 2.5

Apache-2.0

• Milan Sorm

README

Instalace klienta do vašeho PHP projektu:

composer require sailing-cz/api-client

Základní použití veřejných funkcí API:

use Sailing\ApiClient\ApiClient;

$api = new ApiClient( 'your-software/1.0' );

$club = $api->getClubs();

Přihlášení uživatele k sailing.cz:

$api = new ApiClient( 'your-software/1.0' );

$api->loginUser( $username, $password );

$members = $api->getMembers( '2103' );

Vytvoření systémového tokenu na základě uživatelského přihlášení:

$api = new ApiClient( 'your-software/1.0' );

my $systemToken = $api->createSystemToken( $username, $password, 'my-new-secret', 'my-software-token-1' );

// store $systemToken in db or somewhere

Přístup pomocí systémového tokenu:

$api = new ApiClient( 'your-software/1.0', FALSE, '2103' );

$api->loginSystem( $systemToken, $systemSecret );

$api->activateLicense( '2103-0847' );

Změna e-mailu člena ČSJ:

$api = new ApiClient( 'your-software/1.0', FALSE, '2103' );

$api->loginSystem( $systemToken, $systemSecret );

$api->setMemberDetails( '2103-0847', [ 'email' => '[e-mail]' ] );