fireboostio/php-client

This package is abandoned and no longer maintained. The author suggests using the fireboostio/fireboost-php-client package instead.

This package is a php client to the fireboostio api.

v0.0.7 2025-06-21 14:16 UTC

Requires

• php: ^7.3 || ^8.0
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^7.3
• guzzlehttp/psr7: ^2.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.12
• phpunit/phpunit: ^8.0 || ^9.0

MIT

• Bodor Szilard

• php
• rest
• api
• sdk
• fireboostio
• firebostioapi

README

This PHP client allows you to communicate with the Fireboost API. For login credential extraction, you can use the php-encryptor repository.

Installation

You can install the PHP client via Composer:

composer require fireboostio/fireboost-php-client

Usage

Authentication and Obtaining JWT Token

To authenticate and obtain a JWT token for further communication, use the following code snippets:

Without the Encryptor Repository

use FireboostIO\Api\FireboostApi;
use FireboostIO\Model\LoginInput;

$api = new FireboostApi();
$response = $api->login(new LoginInput([
    'encrypted_api_key' => 'your_encrypted_api_key'
]));
$jwt = $response->getJwtToken();

With the Encryptor Repository

use FireboostIO\Api\FireboostApi;
use Fireboostio\Encryptor\CredentialExtractor;
use FireboostIO\Model\LoginInput;

$encryptor = new CredentialExtractor();
$loginInputData = $encryptor->getLoginInputData($fireboostioKey);

$api = new FireboostApi();
$response = $api->login(new LoginInput($loginInputData));
$jwt = $response->getJwtToken();

Setting the JWT Token for Secure API Calls

Once you have the JWT token, set it in the client configuration for further secure API calls:

use FireboostIO\Configuration;

$config = new Configuration();
$config->setAccessToken($jwt);
$config->setApiKeyPrefix('bearer', 'Bearer');

$api = new FireboostIO\Api\FireboostApi(null, $config);

API Examples

Read a Cache (Secure Endpoint)

$response = $api->getCache('cache_key');
var_dump($response->getResult()[0]);

Write Cache (Secure Endpoint)

use FireboostIO\Model\SetInput;

$response = $api->setCache(new SetInput([
    'cache_key' => 'test.com/news/post/1234',
    'content' => json_encode(['whatever' => 'you like']),
    'is_public' => true // or false
]));

Read a Public Cache (Non-Secure Endpoint)

$response = $api->publicGetCache('cache_key');
var_dump($response->getResult()[0]);

LICENSE

This project is licensed under the MIT License. See the LICENSE file for details.