PHP client to interact with our IdP ID Broker's API.
This client is built on top of Guzzle, the PHP HTTP Client. Guzzle has a simple way to create API clients by describing the API in a Swagger-like format without the need to implement every method yourself. So adding support for more APIs is relatively simple.
Installation is simple with Composer:
$ composer require silinternational/idp-id-broker-php-client
Example:
<?php
use Sil\Idp\IdBroker\Client\IdBrokerClient;
$idBrokerClient = new IdBrokerClient(
'https://api.example.com/', // The base URI for the API.
'DummyAccessToken', // Your HTTP header authorization bearer token.
[
'http_client_options' => [
'timeout' => 10, // An (optional) custom HTTP timeout, in seconds.
],
]
);
$users = $idBrokerClient->listUsers();Information about a user returned by this client (such as by getUser(...)) can
include the following fields:
employee_id(string)first_name(string)last_name(string)display_name(string)username(string)email(string)active(string: 'yes' or 'no')locked(string: 'yes' or 'no')
To run the unit tests for this, run make test.
- Tutorial on developing an API client with Guzzle Web Services:
http://www.phillipshipley.com/2015/04/creating-a-php-nexmo-api-client-using-guzzle-web-service-client-part-1/ - Presentation by Jeremy Lindblom:
https://speakerdeck.com/jeremeamia/building-web-service-clients-with-guzzle-1 - Example by Jeremy Lindblom:
https://github.com/jeremeamia/sunshinephp-guzzle-examples - Parameter docs in source comments:
https://github.com/guzzle/guzzle-services/blob/master/src/Parameter.php - Guzzle 3 Service Descriptions documentation (at least mostly still relevant):
https://guzzle3.readthedocs.org/webservice-client/guzzle-service-descriptions.html