Integrate AkwaabaHRPay with your existing systems using our comprehensive REST API. Built for developers, designed for Ghana's business needs.
Follow these steps to start integrating with the AkwaabaHRPay API
Sign up for an AkwaabaHRPay account and generate your API keys from the developer dashboard.
Use OAuth 2.0 to authenticate your application and get access tokens for API requests.
Start making API calls to manage employees, process payroll, and generate reports.
Complete reference for all available endpoints and their parameters
/api/auth/loginAuthenticate user and get access token
/api/auth/refreshRefresh access token using refresh token
/api/auth/logoutInvalidate current session
// Authentication Example
const response = await fetch('/api/auth/login', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
email: 'admin@company.com',
password: 'your-password'
})
});
const { access_token, refresh_token } = await response.json();
// Use token in subsequent requests
const employeesResponse = await fetch('/api/employees', {
headers: {
'Authorization': `Bearer ${access_token}`,
'Content-Type': 'application/json'
}
});Official SDKs and community libraries to accelerate your integration
Official JavaScript/TypeScript SDK for Node.js and browser environments.
npm install @akwaabahr/sdkOfficial Python SDK with full support for all API endpoints and features.
pip install akwaabahr-pythonCommunity-maintained PHP SDK for Laravel and other PHP frameworks.
composer require akwaabahr/php-sdk