Admin Panel API - itsvermaji/speedlabs-ekart-module GitHub Wiki

SECTIONS

Authentication

#FFCC00 [POST] Institute Admin Registration

api/admin/auth/register

Body raw

{
    "name": "Hogwarts School of Witchcraft and Wizardry",
    "city": "Some City of Scotland",
    "email": "[email protected]",
    "password": "hello123"
}

#FFCC00 [POST] Admin Login

api/admin/auth/login

Body raw

{
    "email": "[email protected]",
    "password": "hello123"
}

PRODUCTS

#007500 [GET] Published Products

Authorization Bearer Token

api/admin/product/myproducts

#007500 [GET] Product Details

Authorization Bearer Token

api/admin/product/98

#007500 [GET] Enrolled Students

Authorization Bearer Token

api/admin/product/99/students

#FFCC00 [POST] Create Course

Authorization Bearer Token

api/admin/product/createproduct

Body raw

{
    "image_name": "spell_casting_course_course.jpg",
    "image_url": "https://spells8.com/wp-content/uploads/2019/03/Spellcasting-online-course-750x505.jpg",
    "product_name": "Mastery to Sectumsempraa",
    "creator_name": "Severus Snape",
    "product_type": "Video Lectures",
    "category": 33,
    "sub_category": 34,
    "label": "Private",
    "status": "Unpublished",
    "short_description": "this is a short description.",
    "description": "This is the course/product description",
    "you_will_learn": "develop the ability to use 'Sectumsempra' Spell to defeat the Dark Lord.",
    "this_includes": "This includes block.",
    "pre_requisites": "All my previous classes.",
    "set_currency": "₹",
    "price": 9999.99,
    "discount": 30
}

#19BDFF [PUT] Update Course

Authorization Bearer Token

api/admin/product/98/update

Body raw

{
    "image_name": "spell_casting_course_course.jpg",
    "image_url": "https://spells8.com/wp-content/uploads/2019/03/Spellcasting-online-course-750x505.jpg",
    "product_name": "Mastery to Sectumsempraa",
    "creator_name": "Severus Snape",
    "product_type": "Video Lectures",
    "category": 33,
    "sub_category": 34,
    "label": "Private",
    "status": "Unpublished",
    "tot_students": 101,
    "short_description": "this is a short description.",
    "description": "The is the description.",
    "this_includes": "This includes block.",
    "you_will_learn": "develop the ability to use 'Sectumsempra' Spell to defeat the Dark Lord.",
    "pre_requisites": "All my previous classes.",
    "set_currency": "₹",
    "price": 9999.99,
    "discount": 30
}

#FF0000 [DEL] Delete Product

Authorization Bearer Token

api/admin/product/112/delete

#FFCC00 [POST] Upload Content

Authorization Bearer Token

api/admin/product/98/upload

Body

{
    "section_order": 2,
    "resource_order": 3,
    "resource_type": "pdf",
    "is_paid": 1,
    "section_name": "Introduction 4", 
    "image_url": "https://google.com",
    "resource_name": "video.mp4", 
    "resource_url": "https://www.youtube.com/watch?v=p2oIXSgqUjk&list=PLjILk0vh4yJRKE5fTcdej7lsu69bFOVKY&index=1"
}

#FF0000 [DEL] Remove Content

Authorization Bearer Token

api/admin/product/98/delete/15

#FFCC00 [POST] Upload Resource

Authorization Bearer Token

api/admin/product/uploadcontent

Body formdata

{
    image: file.attachment
}

#FFCC00 [POST] Course Allotment

Authorization Bearer Token

api/admin/product/allotcourse

Body raw

{
    "course_id": 98,
    "students":[4, 5] 
}

Coupons

#007500 [GET] All Coupons

Authorization Bearer Token

api/admin/coupon/allcoupons

#007500 [GET] Coupon Details

Authorization Bearer Token

api/admin/coupon/43

#FFCC00 [POST] Create Coupon

Authorization Bearer Token

api/admin/coupon/create

Body raw

{
    "coupon_quantity": 10,
    "coupon_code": "HOGWARTS500",
    "on_course_id": 103,
    "description": "This is the course description",
    "label": "active",
    "discount_percent": 80,
    "valid_from": "2021/06/30",
    "valid_till": "2021/07/12",
    "terms_and_conditions": "A separate column for terms and conditions"
}

#19BDFF [POST] Update Coupon Details

Authorization Bearer Token

api/admin/coupon/45/update

Body raw

{
    "coupon_quantity": 10,
    "coupon_code": "HOGWARTS50",
    "on_course_id": 100,
    "description": "This is the course description",
    "label": "active",
    "discount_percent": 50,
    "valid_from": "2021/06/16",
    "valid_till": "2021/06/23",
    "terms_and_conditions": "A separate column for terms and conditions"
}

Categories

#007500 [GET] All Categories

Authorization Bearer Token

api/admin/category/allcategories

#FFCC00 [POST] Create Category

Authorization Bearer Token

api/admin/category/create

Body raw

{
    "name": "New Sub2 Cat",
    "parent_id": 34
}

#FF0000 [DEL] Delete Category

Authorization Bearer Token

api/admin/category/37/delete

Students

#007500 [GET] All Students

Authorization Bearer Token

api/admin/student/regstudents

#FFCC00 [POST] Register Student

Authorization Bearer Token

api/users/auth/register

Body raw

{
    "user_first_name": "Ron",
    "user_last_name": "Potter",
    "user_email": "[email protected]",
    "password": "hello123",
    "user_college_id": 122,
    "country_code": "+91",
    "user_contact_no": "0123456789",
    "user_country_name": "India",
    "user_state_name": "Maharashtra",
    "user_city_name": "Mumbai",
    "user_address": "abc street 3",
    "zip_code": "125323",
    "user_gender": "Male",
    "user_dob": "2001-01-01"
}

#007500 [GET] Student Details

Authorization Bearer Token

api/admin/student/1

#19BDFF [PUT] Update Details

Authorization Bearer Token

api/admin/student/1/update

Body raw

{
    "user_first_name": "Cherry",
    "user_last_name": "Mineral",
    "user_college_id": 132,
    "country_code": "+91",
    "user_contact_no": "0123456789",
    "user_country_name": "India",
    "user_state_name": "Maharashtra",
    "user_city_name": "Mumbai",
    "user_address": "abc street 3",
    "zip_code": "125323",
    "user_gender": "Male",
    "user_dob": "2001-01-01"
}

#FF0000 [DEL] Delete Student Account

Authorization Bearer Token

api/admin/student/6/delete

Orders

#007500 [GET] All Orders

Authorization Bearer Token

api/admin/orders

#007500 [GET] Order Details

Authorization Bearer Token

api/admin/orders/25/details

Dashboard

  • Institute Details
  • Total Counts

My Products

  • All Product List
  • View Product Details
  • Create, Update, and Delete Product

Categories

  • All categories List
  • Add and Delete Category

Coupons

  • All Coupons List
  • Create, Update, and Delete Coupon

Students

  • All Students List
  • View Student Details
  • Add, Update and Delete Student

Orders

  • List of orders corresponding to that institute
  • View Order Details
  • Update and Delete Order