A
HR
AkwaabaHRPayGhana HR & Payroll

API Documentation

Integrate AkwaabaHRPay with your existing systems using our comprehensive REST API. Built for developers, designed for Ghana's business needs.

50+
API Endpoints
99.9%
Uptime SLA
OAuth 2.0
Authentication
JSON
Response Format

Getting Started

Follow these steps to start integrating with the AkwaabaHRPay API

1. Get API Keys

Sign up for an AkwaabaHRPay account and generate your API keys from the developer dashboard.

2. Authenticate

Use OAuth 2.0 to authenticate your application and get access tokens for API requests.

3. Make Requests

Start making API calls to manage employees, process payroll, and generate reports.

API Reference

Complete reference for all available endpoints and their parameters

Authentication Endpoints
POST/api/auth/login

Authenticate user and get access token

Parameters: email, password
POST/api/auth/refresh

Refresh access token using refresh token

Parameters: refresh_token
POST/api/auth/logout

Invalidate current session

Code Example
// 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'
  }
});

SDKs & Libraries

Official SDKs and community libraries to accelerate your integration

JavaScript SDK

Official JavaScript/TypeScript SDK for Node.js and browser environments.

npm install @akwaabahr/sdk

Python SDK

Official Python SDK with full support for all API endpoints and features.

pip install akwaabahr-python

PHP SDK

Community-maintained PHP SDK for Laravel and other PHP frameworks.

composer require akwaabahr/php-sdk

Need Help?

Our developer support team is here to help you integrate successfully