API Documentation

Integrate Alghahim Africa LMS with your school website

RESTful API

Standard REST endpoints for all operations

Secure Authentication

API key and OAuth 2.0 support

Webhooks

Real-time event notifications

Getting Started

1. Authentication

Each registered school receives secure API credentials:

School ID: YOUR_SCHOOL_ID

Public Key: YOUR_PUBLIC_KEY

Secret Key: YOUR_SECRET_KEY

2. Base URL

https://api.lms.alghahim.co.ke/v1

3. Headers

Authorization: Bearer YOUR_SECRET_KEY

Content-Type: application/json

X-School-ID: YOUR_SCHOOL_ID

API Endpoints

POST/schools/register

GET/school/{school_id}/students

Get all students for a school

POST/students/admit

Admit a new student

GET/students/{student_id}/results

Get student academic results

POST/payments/webhook

Receive payment notifications

GET/school/{school_id}/analytics

Get school analytics and reports

Example Request

Admit a Student

curl -X POST https://api.lms.alghahim.co.ke/v1/students/admit \
  -H "Authorization: Bearer YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -H "X-School-ID: YOUR_SCHOOL_ID" \
  -d '{
    "first_name": "John",
    "last_name": "Doe",
    "email": "john@example.com",
    "class": "Form 1",
    "admission_number": "HB/2025/001"
  }'

Rate Limiting

API requests are rate limited to prevent abuse:

1000 requests per hour for standard plans
5000 requests per hour for enterprise plans
Rate limit headers are included in all responses

Need Help?

API Support

For API documentation, examples, and support:

Email: api-support@alghahim.co.ke

Phone: +254 716 319 763

Documentation: https://docs.lms.alghahim.co.ke