taravel/16. `docs/api.md

1.4 KiB

API Documentation

Authentication

POST /api/login

  • Description: Authenticate a user and generate a token.
  • Request Body: JSON object with email and password.
  • Response: JSON object with the generated token.

POST /api/logout

  • Description: Logout the user and revoke the token.
  • Response: JSON object with a success message.

Admin Management

GET /api/admin/users

  • Description: Get a list of users (restricted to member users).
  • Response: JSON object with a list of users.

POST /api/admin/users/{user}/activate

  • Description: Activate a user (restricted to member users).
  • Response: JSON object with a success message.

POST /api/admin/users/{user}/deactivate

  • Description: Deactivate a user (restricted to member users).
  • Response: JSON object with a success message.

Frontend API

GET /api/frontend

  • Description: Get frontend data.
  • Response: JSON object with a message.

POST /api/frontend

  • Description: Store frontend data.
  • Request Body: JSON object with required fields.
  • Response: JSON object with a success message.

Backend API

GET /api/backend

  • Description: Get backend data.
  • Response: JSON object with a message.

POST /api/backend

  • Description: Store backend data.
  • Request Body: JSON object with required fields.
  • Response: JSON object with a success message.