Skip to content

Latest commit

 

History

History
44 lines (33 loc) · 1.15 KB

README.md

File metadata and controls

44 lines (33 loc) · 1.15 KB
Raw

The unofficial PHP SDK for PianoID API

Documentation

https://docs.piano.io/piano-id-api

Install the library

composer require ledevoir/pianoid-api-php-sdk

Configuration requirements

Configure the following environment variables (must be set in $_ENV[] variable) or configure values manually in the Environment object

PIANO_ID_API_BASE_URL='www.whatever.com'
PIANO_APPLICATION_ID='valid_application_id'
PIANO_API_TOKEN='VERY_SECURE_TOKEN'

Usage example

use \LeDevoir\PianoIdApiSDK\Client\GuzzleClient;
use \LeDevoir\PianoIdApiSDK\Request\Login\LoginRequest;

$client = new GuzzleClient();
$request = new LoginRequest('[email protected]', 'password');

$httpResponse = $client->send($request);
$pianoResponse = $request->toPianoIdResponse($httpResponse);

$failed = $pianoResponse->isFailure();

Tests

To debug unit tests

 XDEBUG_TRIGGER=yes vendor/bin/phpunit tests

Future outlook / TODO

  • Might consider guzzle interfaces and main classes (request, response & client integration further ?)
  • Consider removing guzzle client and replacing with cURL client or add client interface and provide both options