๐Ÿšข Marine Training Platform

Admin Dashboard & API Documentation

Checking...
Database Status
Checking...
API Status
-
Total Users

๐Ÿ” Authentication Endpoints

POST
/api/v1/auth/signup
Create new user account with OTP verification
POST
/api/v1/auth/verifyOTP
Verify OTP for account activation
POST
/api/v1/auth/requestNewOtp
Request new OTP for verification
POST
/api/v1/auth/login
User login authentication
POST
/api/v1/auth/logout
User logout (requires authentication)
GET
/api/v1/auth/user
Get current user details (requires authentication)
PATCH
/api/v1/auth/passwordReset
Change user password (requires authentication)

๐Ÿ“š Courses Management

POST GET
/api/v1/courses
Create new course or get all courses (requires authentication)
PATCH
/api/v1/courses/count/:courseName
Update course count (requires authentication)
GET PATCH DELETE
/api/v1/courses/:id
Get, update, or delete specific course

๐ŸŽ“ Enrollment Management

POST GET
/api/v1/enrollments
Create new enrollment or get all enrollments
GET PATCH DELETE
/api/v1/enrollments/:id
Get, update, or delete specific enrollment (auth required for update/delete)

POST Request Body Fields for Enrollment

firstName

string - First name of the student

middleName

string - Middle name of the student (optional)

lastName

string - Last name of the student

dob

string - Date of birth (YYYY-MM-DD)

gender

string - Gender (male/female)

marital

string - Marital status

email

string - Email address

gsm

string - Phone number

country

string - Country

state

string - State

courseName

string - Name of the course

enrollDate

string - Date of enrollment

amount

string - Payment amount

means

string - Means of identification (e.g. Passport, ID card)

meansId

string - ID number

photo

string - URL or path to photo

refNum

string - Reference number

โฐ Training Sessions

POST GET
/api/v1/sessions
Create or get training sessions (requires authentication)
PATCH DELETE
/api/v1/sessions/:id
Update or delete specific session (requires authentication)

๐Ÿ”ผ Uploads Sessions

POST
/api/v1/upload
Upload students passport
POST
/api/v1/certificate
Upload certificate template (auth required for post)

๐Ÿ›  Additional Services

POST
/api/v1/notify/boss
Send email notifications to boss/admin
POST
/api/v1/paystack
Payment processing with Paystack
GET
/api/v1/health
Check Database Connection

๐Ÿงช Test API Endpoints

Response will appear here...