Skip to main content

PHP Client

Installing the client​

At this time, to install the PHP client you must retrieve an archive that contains the client, which is available at the following URL: https://pkg.bluemind.net/pkg/"BM technical number"/clients/

Using the client​

Authentication​

The client uses the BMClient class to start:

<?php
require 'BM/AuthenticationClient.php';
require 'BM/DomainsClient.php';

$url="https://external-url";
$token="admin";

$authClient = new BM\AuthenticationClient($url, NULL);
$loginResponse = $authClient->login('admin0@global.virt', $token, 'bm-php-client');
echo "Login result : ".$loginResponse->status;
?>

"url" is the URL used to access the BlueMind server.

"token" is the admin0 password or token. In this example we use admin0, but you can also authenticate with any other user. You can also authenticate as a user with:

<?php
require 'BM/AuthenticationClient.php';
require 'BM/DomainsClient.php';

$url="https://external-url";
$token="admin";

$authClient = new BM\AuthenticationClient($url, NULL);
$loginResponse = $authClient->login('admin0@global.virt', $token, 'bm-php-client');
print "Login result : ".$loginResponse->status;
$authClient = new BM\AuthenticationClient($url, $loginResponse->authKey);
$token = $authClient->su("user@local.lan");
print "sudo result : ".$token->status
?>

Please note that you can also use users' API key instead of their login ID (username).

Listing domains​

<?php
require 'BM/AuthenticationClient.php';
require 'BM/DomainsClient.php';

$url="https://external-url";
$token="admin";

$authClient = new BM\AuthenticationClient($url, NULL);
$loginResponse = $authClient->login('admin0@global.virt', $token, 'bm-php-client');
print "Login result : " + $loginResponse->status;

$domainClient = new BM\DomainsClient($url, $loginResponse->authKey);
$domains = $domainClient->all();
#var_dump($domains);
foreach ($domains as $domain)
{
    print $domain->value->name."\n";
}
?>

Listing events​

<?php
require 'BM/AuthenticationClient.php';
require 'BM/DomainsClient.php';
require 'BM/UserClient.php';
require 'BM/CalendarClient.php';
require 'BM/ContainersClient.php';
require 'BM/ContainerQuery.php';

// BEGIN CONF
$url="https://external-url";
$token="admin";
$user="user@local.lan";
$domain="local.lan";
// END CONF

$authClient = new BM\AuthenticationClient($url, NULL);
$loginResponse = $authClient->login('admin0@global.virt', $token, 'bm-php-client');
//var_dump($loginResponse);
print "Login result : " + $loginResponse->status;

$userClient =  New BM\UserClient($url, $loginResponse->authKey, $domain);
$userValue = $userClient->byEmail($user);

$containersClient =  New BM\ContainersClient($url, $loginResponse->authKey);
$query = New BM\ContainerQuery();
$query->owner = $userValue->uid;
$query->type = "calendar";
$containers = $containersClient->allForUser($domain, $userValue->uid, $query);

foreach ($containers as $container)
{
    print "calendar : ".$container->name. " uid : ".$container->uid."\n";
    $calendarClient =  New BM\CalendarClient($url, $loginResponse->authKey, $container->uid);
    foreach ($calendarClient->list_()->values as $event)
    {
        print "Event : ".$event->value->main->summary."\n";
    }
}
?>

You can find some examples in our Git repository: https://forge.bluemind.net/stash/projects/BA/repos/bluemind-samples/browse/php-api-examples

FAQ​

Certificate issues​

If you are using an unknown certificate, you must change the value for CURLOPT_SSL_VERIFYPEER to FALSE in the file BM/GlobalEnv.php.

Last updated on