digram / bukua-access
Access Bukua Edtech API services for your Laravel application
v1.0.5
2025-05-10 00:24 UTC
Requires
- php: ^5.6||^7.0||^8.0
README
A Laravel package for integrating with Bukua Edtech API services, providing easy access to schools data.
Features
- Authentication with Bukua API using client credentials
- Simple methods to fetch paginated schools data
Prerequisites
Bukua Developer Account:
- Create a Core Access Client in the Bukua Developer Dashboard.
- Obtain your:
client_id
client_secret
Configuration
- Add the following to your
.env
file:
BUKUA_ACCESS_CLIENT_ID=your-client-id BUKUA_ACCESS_CLIENT_SECRET=your-client-secret BUKUA_BASE_URL="https://bukua-core.apptempest.com/"
Installation
- In your terminal, run
composer require digram/bukua-access
- Clear your configuration cache by running
php artisan cache:clear
Usage
Fetching Counties
Get a paginated list of counties:
Parameters:
$page
: Page number (starting from 1)$per_page
: Number of items per page
use BukuaAccess\Facades\BukuaAccess; try { $counties = BukuaAccess::counties(page: 1, per_page: 10); dd($counties); } catch (\Exception $e) { // Handle error }
Fetching Subjects
Get a paginated list of subjects:
Parameters:
$page
: Page number (starting from 1)$per_page
: Number of items per page
use BukuaAccess\Facades\BukuaAccess; try { $subjects = BukuaAccess::subjects(page: 1, per_page: 10); dd($subjects); } catch (\Exception $e) { // Handle error }