Scamzap API

This API helps detect scams, educate users, and store user reports securely using the Scamzap platform.

Available Routes

• /ping – Check if the API is online
• /users – User-related operations
• /scams – Reported scams and lookup
• /lessons – Anti-scam educational lessons
• /admin – Admin-only operations

API Guide

/ping

• GET /ping – Returns { message: "API is online" }

/users

• GET /users – List all users
• POST /users – Create a user.
  Body: { id, name, email }
• GET /users/:id – Get user by id

/scams

• GET /scams – List all scams
• POST /scams – Report a scam.
  Body: { ...scam fields }
• GET /scams/categories – List all scam categories
• GET /scams/category/:category – List scams by category
• GET /scams/recent – List scams reported in the last 7 days
• GET /scams/user/:userId – List scams submitted by a user
• GET /scams/:id – Get scam by id

/lessons

• GET /lessons – List all lessons
• GET /lessons/:id – Get lesson by id
• GET /lessons/:lessonId/quiz/:quizId – Get quiz by quizId in a lesson

/users (Follow System)

• POST /users/follow – Follow a user.
  Body: { userId, targetId }
• POST /users/unfollow – Unfollow a user.
  Body: { userId, targetId }
• GET /users/followers/:userId – List followers of a user
• GET /users/following/:userId – List users followed by a user

/admin

• GET /admin/role/:id – Get role of a user
• GET /admin/users?userId=ADMIN_ID – List all users (admin only)
• POST /admin/promote/:id?userId=ADMIN_ID – Promote user to admin
• POST /admin/demote/:id?userId=ADMIN_ID – Demote admin to user
• GET /admin/stats?userId=ADMIN_ID – Get lesson and quiz stats
• GET /admin/scams?userId=ADMIN_ID – List all scams (admin only)
• DELETE /admin/scams/:id?userId=ADMIN_ID – Delete scam (admin only)
• POST /admin/lessons – Create lesson
• POST /admin/lessons/:lessonId/quiz?userId=ADMIN_ID – Add quiz to lesson
• PUT /admin/lessons/:lessonId/quiz/:quizId?userId=ADMIN_ID – Edit quiz in lesson

Notes

• Admin routes require userId of an admin as a query parameter.
• All endpoints return JSON responses.
• For more details, see the Scamzap platform.