A simple REST client to interact with Jaeger REST API installations.
Add jaeger-app/rest-client
as a requirement to composer.json
:
$ composer require jaeger-app/rest-client
use \JaegerApp\Rest\Client;
$client = new Client();
$backups = $client->setApiKey($api_key)
->setApiSecret($api_secret)
->setSiteUrl($api_endpoint_url)
->get('/backups');
Jaeger uses HMAC-SHA authentication which is a simple key / secret paradigm to create hashed signatures. You can get/set your api key and secret, as well as the API URL endpoint, from your individual Jaeger installations.
If anything goes wrong with a request the library will return an ApiProblem object. Here's an example:
use \JaegerApp\Rest\Client;
use \JaegerApp\Rest\ApiProblem;
$client = new Client();
$result = $client->setApiKey($api_key)
->setApiSecret($api_secret)
->setSiteUrl($api_endpoint_url)
->get('/myendpoint');
if($result instanceof ApiProblem)
{
if($result->getStatus() == 403) {
//authentication issue
}
$result->getTitle() //API problem response title
$result->getDetail() //API problem response details
}
For all successful responses from the Jaeger API, the library will return an instance of \JaegerApp\Rest\Client\Hal
object which is a wrapper for \Nocarrier\Hal.
use \JaegerApp\Rest\Client;
use \JaegerApp\Rest\Hal;
$client = new Client();
$result = $client->setApiKey($api_key)
->setApiSecret($api_secret)
->setSiteUrl($api_endpoint_url)
->get('/myendpoint');
if($result instanceof Hal)
{
$data = $result->getData();
$resources = $result->getResources();
}
Since Jaeger follows the [Richardson Maturity Model](Richardson Maturity Model) there are helper methods available for each HTTP verb. Below are some simple use case examples and their implementations
use \JaegerApp\Rest\Client;
$client = new Client();
$result = $client->setApiKey($api_key)
->setApiSecret($api_secret)
->setSiteUrl($api_endpoint_url)
->post('/myendpoint');
use \JaegerApp\Rest\Client;
$client = new Client();
$settings = array('working_directory' => '/path/to/working_directory');
$update = $client->setApiKey($api_key)
->setApiSecret($api_secret)
->setSiteUrl($api_endpoint_url)
->put('/settings', $settings);
use \JaegerApp\Rest\Client;
$client = new Client();
$settings = $client->setApiKey($api_key)
->setApiSecret($api_secret)
->setSiteUrl($api_endpoint_url)
->get('/settings');
use \JaegerApp\Rest\Client;
$client = new Client();
$storage_locations = $client->setApiKey($api_key)
->setApiSecret($api_secret)
->setSiteUrl($api_endpoint_url)
->get('/storage');