bokbasen/php-sdk-auth

PHP SDK for Bokbasen API authentication service

v2.0.3 2018-11-29 12:22 UTC

This package is not auto-updated.

Last update: 2020-08-07 20:18:14 UTC


README

This PHP SDK enables easy usage of Bokbasen's authentication service that is required for accessing any of Bokbasen's API such as digital distribution platform, metadata or orders. Bokbasen's APIs are not public and only available on commercial terms, you must have a username/password from Bokbasen in order to use this package.

The basic package enable creation of a TGT that can be used for further login to API services. The package also provides an interface for caching TGTs so one can get a more efficient flow, only renewing TGT when it is about to expire. For production usage this is highly recommended. The API documentation is available on this page.

HTTP client

The SDK has a dependency on the virtual package php-http/client-implementation which requires to you install an adapter, but we do not care which one. That is an implementation detail in your application. We also need a PSR-7 implementation and a message factory.

This is based on PHP-HTTP that provides an implementation-independent plugin system to build pipelines regardless of the HTTP client implementation used. So basically you can plugin whichever HTTP implementation you would like to use.

I do not care, I just want it to work!

By adding a compatible HTTP adapter to your project the SDK will automatically detect the package and use this adapter. As long as you do not need any specific HTTP settings injected (such as proxy settings etc.) this will work just fine.

$ composer require php-http/guzzle6-adapter

Auto detected client and TGT cache

In production environments you should always use teh caching feature. Not doing this will potentially give you a significant performance impact on the response time from Bokbasen's APIs. You can cache the TGT using any PSR-6 compatible package. Example below is using Symfony's file caching.

<?php
use Bokbasen\Auth\Login;
use Symfony\Component\Cache\Adapter\FilesystemAdapter;
try{
	$cache = new FilesystemAdapter();
	$auth = new Login('my_username', 'my_password', Login::URL_PROD, $cache);
   //If the TGT is cached, the SDK will only call the Bokbasen login server when the token is set to expire
} catch(\Exception $e){
	//error handling
}
?>

Use injected HTTP client

<?php
use Bokbasen\Auth\Login;
try{
	//just an example, any client implementing \Http\Client\HttpClient\HttpClient will work
	$client = new \Http\Adapter\Guzzle6\Client();
	$auth = new Login('my_username', 'my_password', Login::URL_PROD, null, null, $client);
} catch(\Exception $e){
	//error handling
}
?>