EduPulse Smart Schools
EduPulse Africa Developer Hub v1.0

Unified REST API Directory & Developer Documentation Portal

api 8 Role-Based Mobile & Web REST API Suites

EduPulse REST API Directory & Developer Hub

Welcome to the central developer portal for the EduPulse School Management Ecosystem. Access interactive HTML API explorers and complete Markdown specifications with 100% full request payloads and realistic JSON responses for all 8 application roles.

terminal API Base Endpoint
http://localhost/edupulse/index.php?api=<ROLE>
key Authentication Header
Authorization: Bearer <TOKEN>
apps Total Modules & Endpoints
120 Modules • 240+ Endpoints
search
family_restroom
15 MODULES

Parent Mobile App API

Student academics, digital UNEB report cards, instant MTN/Airtel MOMO school fees payment, live GPS school bus tracker, sickbay clinic alerts & digital gate pass QR codes.

API Route ?api=parent
View Interactive Docs arrow_forward
Markdown: PARENT_API_DOCUMENTATION.md
school
15 MODULES

Teacher Mobile App API

Teacher GPS shift clock-in, morning roll call attendance, marks entry with automated UNEB 8-in-4 grading, CBC report card remarks, lesson planning & salary payslips.

API Route ?api=teacher
View Interactive Docs arrow_forward
Markdown: TEACHER_API_DOCUMENTATION.md
directions_bus
15 MODULES

Driver & Fleet API

Live real-time GPS telemetry stream (10s beacon), student bus boarding/drop-off barcode scanner, morning/evening passenger manifests, fuel consumption & speed logging.

API Route ?api=driver
View Interactive Docs arrow_forward
Markdown: DRIVER_API_DOCUMENTATION.md
bed
15 MODULES

Matron & Warden API

Boarding house night headcount roll call, dorm bed allocations, weekend exeats & leave passes, dining hall roll call, sickbay referrals & dormitory inspections.

API Route ?api=matron
View Interactive Docs arrow_forward
Markdown: MATRON_API_DOCUMENTATION.md
security
15 MODULES

Gate Security & Access API

Universal 4-in-1 camera scanner (Student ID, Visitor Pass QR, Staff badge, Parent Pickup Pass), vehicle ingress/egress log, visitor badge printer & night lockdown SOS.

API Route ?api=security
View Interactive Docs arrow_forward
Markdown: GATE_SECURITY_API_DOCUMENTATION.md
menu_book
15 MODULES

Librarian & Library API

Universal 4-in-1 ISBN & Student barcode scanner, book catalog inventory, rapid circulation loan issuing & condition returns, overdue fine calculation & digital e-books.

API Route ?api=librarian
View Interactive Docs arrow_forward
Markdown: LIBRARIAN_API_DOCUMENTATION.md
medical_services
15 MODULES

Nurse & Sickbay Clinic API

Patient triage barcode scanning, vitals examination (°C, BP, Pulse), sickbay bed ward admission & discharge, pharmacy dispensation, parent SMS emergency alerts & hospital transfers.

API Route ?api=nurse
View Interactive Docs arrow_forward
Markdown: NURSE_API_DOCUMENTATION.md
work
15 MODULES

Sales Person & Partner API

Direct school onboarding engine, CRM deals pipeline, GPS field visit check-in, real-time 20% lifetime commission ledger, instant MOMO wallet withdrawals & WhatsApp referral generator.

API Route ?api=sales
View Interactive Docs arrow_forward
Markdown: SALES_API_DOCUMENTATION.md

folder_open Local Filesystem Directory & File Locations

All documentation files and backend controller implementations are located in the local codebase repository as follows:

Module Role Interactive HTML Viewer Complete Markdown File Backend API Controller
family_restroom Parent App documentation/parent_api_documentation.html documentation/PARENT_API_DOCUMENTATION.md app/Controllers/Api/ParentApiController.php
school Teacher App documentation/teacher_api_documentation.html documentation/TEACHER_API_DOCUMENTATION.md app/Controllers/Api/TeacherApiController.php
directions_bus Driver & Bus App documentation/driver_api_documentation.html documentation/DRIVER_API_DOCUMENTATION.md app/Controllers/Api/DriverApiController.php
bed Matron & Warden App documentation/matron_api_documentation.html documentation/MATRON_API_DOCUMENTATION.md app/Controllers/Api/MatronApiController.php
security Gate Security App documentation/security_api_documentation.html documentation/GATE_SECURITY_API_DOCUMENTATION.md app/Controllers/Api/SecurityApiController.php
menu_book Librarian App documentation/librarian_api_documentation.html documentation/LIBRARIAN_API_DOCUMENTATION.md app/Controllers/Api/LibrarianApiController.php
medical_services School Nurse App documentation/nurse_api_documentation.html documentation/NURSE_API_DOCUMENTATION.md app/Controllers/Api/NurseApiController.php
work Sales Person App documentation/sales_api_documentation.html documentation/SALES_API_DOCUMENTATION.md app/Controllers/Api/SalesApiController.php