Spurtcommerce
DocumentAPI ReferenceAdd-ons
API Reference
API Reference
  • About Spurtcommerce APIs
  • Spurtcommerce
    • Admin API
      • Admin
        • Authentication
        • My Profile
      • Buyers
        • Manage Buyer
      • Chat
      • CMS
        • Manage Banner
        • Manage Blogs
        • Manage Pages
        • Manage SEO
      • Dashboard
      • Marketing
        • Manage Cross Selling
          • Related Products
        • Manage Promotions
          • Coupon
      • Marketplace
        • Manage Products
        • Manage Sales
        • Manage Settlements
        • Product Configuration
        • Reports
      • Sellers
        • Seller
        • Seller Group
        • Seller KYC Request
      • Settings
        • Add-ons
        • Add-ons Product Attributes
        • Localization
        • Order Fulfilment Status
        • Personalise
        • Site Settings
        • Store Settings
        • System
        • User and Permission
    • Store API
      • Account Settings
        • Customer
        • My Order
        • My Quotation
        • My Wishlist
        • Profile
      • Checkouts
      • Store
        • Admin Contact
        • Categories
        • Home
        • Product Detail Page
    • Vendor API
      • Catalogue
        • Bulk Product Imports
          • Custom
          • Standard
        • Common Product
        • Data Export
        • Pricing
        • Product List
        • Product Localisation
        • Product Variants
        • Related Products
      • CRM
        • Customer
        • Customer Group
        • Question and Answer
        • Rating and Review
      • Dashboard
      • Marketing
      • Payments
        • Archeived Payments
        • Earnings
        • Settlements
      • Profile
        • Account Settings
          • My Business
          • My KYC
          • My Profile
          • My Shop
          • Personalised Setting
        • Chat
        • Vendor
      • Reports
      • Sales
        • Archeive Orders
        • Back Orders
        • Failed Orders
        • Orders
        • Quotation Request
        • Stock Update
        • Variant Stock Update
      • Supplier
        • Contact
        • Supplier
Powered by GitBook
On this page
  1. Spurtcommerce Core API
  2. Admin API

Authentication

Last updated 3 months ago

User Authentication

Permission Authentication

user list

get

List of users

Query parameters
limitintegerRequired
offsetintegerOptional
keywordstringOptional
countintegerOptional
Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
get
GET /auth/userlist?limit=1 HTTP/1.1
Host: 
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "text"
}

Delete a User

delete

Delete a user

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
400
error response
*/*
delete
DELETE /auth/delete-user/{id} HTTP/1.1
Host: 
Authorization: text
Accept: */*
{
  "status": 1,
  "message": "text"
}

logout

post

User logout.

Header parameters
AuthorizationstringRequired
Responses
200
success response
application/json
400
error response
application/json
post
POST /auth/logout HTTP/1.1
Host: 
Authorization: text
Accept: */*
{
  "status": 1,
  "message": "text"
}

forgot-password-key-check

get

This is for user password key validation.

Query parameters
encryptedKeystringOptional
Responses
200
success response
*/*
get
GET /auth/forgot-password-key-check HTTP/1.1
Host: 
Accept: */*
200

success response

{
  "status": 1,
  "message": "text"
}

Get Profile

get

This is to get the user profile

Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
get
GET /auth/get-profile HTTP/1.1
Host: 
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "text"
}

Get Site Map

get

Get user site map

Responses
200
success response
*/*
get
GET /auth/get-sitemap HTTP/1.1
Host: 
Accept: */*
200

success response

{
  "status": 1,
  "message": "text"
}

login

post

Create a user login

Body
usernamestringRequired
passwordstringRequired
Responses
200
success response
application/json
400
error response
application/json
post
POST /auth/login HTTP/1.1
Host: 
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 37

"username='text'&password='text'"
{
  "createdBy": 1,
  "createdDate": "2025-05-09T07:58:26.437Z",
  "modifiedBy": 1,
  "modifiedDate": "2025-05-09T07:58:26.437Z",
  "userId": 1,
  "avatar": "text",
  "avatarPath": "text",
  "isActive": 1,
  "code": 1,
  "address": "text",
  "deleteFlag": 1,
  "linkExpires": 1,
  "usergroup": {
    "createdBy": 1,
    "createdDate": "2025-05-09T07:58:26.437Z",
    "modifiedBy": 1,
    "modifiedDate": "2025-05-09T07:58:26.437Z",
    "groupId": 1,
    "name": "text"
  }
}

create user

post

Add a new user.

Header parameters
AuthorizationstringRequired
Body
usernamestringRequired
passwordstringRequired
firstNamestringRequired
lastNamestringRequired
emailstringRequired
userGroupIdinteger · int32Required
Responses
200
success response
application/json
400
error response
application/json
post
POST /auth/create-user HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 105

"username='text'&password='text'&firstName='text'&lastName='text'&email='text'&userGroupId=1"
{
  "username": "text",
  "password": "text",
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "deleteFlag": 1,
  "userGroupId": "text",
  "isActive": 1,
  "createdDate": "2025-05-09T07:58:26.437Z",
  "userId": 1
}

Update User

put

Update a user.

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Body
usernamestringRequired
passwordstringOptional
firstNamestringRequired
lastNamestringRequired
emailstringRequired
userGroupIdinteger · int32Required
Responses
200
success response
application/json
400
error response
application/json
422
error response
application/json
put
PUT /auth/update-user/{id} HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 105

"username='text'&password='text'&firstName='text'&lastName='text'&email='text'&userGroupId=1"
{
  "status": 1,
  "message": "text"
}

Forgot the user password

post

Forgrt password

Header parameters
AuthorizationstringRequired
Body
emailstringOptional
Responses
200
success response
application/json
400
error response
application/json
post
POST /auth/forgot-password HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 16

"email='text'"
{
  "status": 1,
  "message": "text"
}

Change the Password

put

Change Password

Header parameters
AuthorizationstringRequired
Body
oldPasswordstringOptional
newPasswordstringOptional
Responses
200
success response
application/json
400
error response
application/json
422
error response
application/json
put
PUT /auth/change-password HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 43

"oldPassword='text'&newPassword='text'"
{
  "status": 1,
  "message": "text"
}

Edit Profile

post

Edit a profile for a user.

Header parameters
AuthorizationstringRequired
Body
usernamestringRequired
emailstringRequired
avatarstringOptional
phoneNumberstringOptional
addressstringOptional
Responses
200
success response
application/json
400
error response
application/json
post
POST /auth/edit-profile HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 88

"username='text'&email='text'&avatar='text'&phoneNumber='text'&address='text'"
{
  "createdBy": 1,
  "createdDate": "2025-05-09T07:58:26.437Z",
  "modifiedBy": 1,
  "modifiedDate": "2025-05-09T07:58:26.437Z",
  "userId": 1,
  "userGroupId": 1,
  "username": "text",
  "password": "text",
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "avatar": "text",
  "avatarPath": "text",
  "isActive": 1,
  "code": 1,
  "ip": "text",
  "phoneNumber": "text",
  "address": "text",
  "deleteFlag": 1,
  "linkExpires": 1,
  "forgetPasswordKey": "text",
  "permission": 1,
  "usergroup": null
}

forgot password link

post

This is for user forget password link.

Body
emailIdstringOptional
Responses
200
success response
application/json
post
POST /auth/forgot-password-link HTTP/1.1
Host: 
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 18

"emailId='text'"
200

success response

{
  "status": 1,
  "message": "text"
}

reset password

put

Users reset their password

Body
newPasswordstringOptional
keystringOptional
Responses
200
success response
application/json
400
error response
application/json
422
error response
application/json
put
PUT /auth/reset-password HTTP/1.1
Host: 
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 35

"newPassword='text'&key='text'"
{
  "status": 1,
  "message": "text"
}
  • User Authentication
  • POSTlogin
  • GETuser list
  • POSTcreate user
  • PUTUpdate User
  • DELETEDelete a User
  • POSTForgot the user password
  • PUTChange the Password
  • POSTEdit Profile
  • POSTlogout
  • POSTforgot password link
  • GETforgot-password-key-check
  • PUTreset password
  • GETGet Profile
  • GETGet Site Map
  • Permission Authentication
  • GETlist
  • POSTadd permission
  • GETget permission
  • GETpermission me

list

get

Get list of permission module.

Query parameters
limitintegerRequired
offsetintegerOptional
countintegerOptional
Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
get
200

success response

get permission

get

Get permission.

Query parameters
refTypeintegerRequired
refIdintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
400
error response
*/*
get

permission me

get

Get permission from me

Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
400
error response
*/*
get
GET /permission-module/list?limit=1 HTTP/1.1
Host: 
Authorization: text
Accept: */*
{
  "status": 1,
  "message": "text"
}

add permission

post

Add permission module.

Header parameters
AuthorizationstringRequired
Body
refTypeinteger · int32Required
refIdinteger · int32Required
permissionstringRequired
Responses
200
success response
application/json
400
error response
application/json
post
POST /permission-module/add-permission HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 43

"refType=1&refId=1&permission='text'"
{
  "status": 1,
  "message": "text"
}
GET /permission-module/get-permission?refType=1&refId=1 HTTP/1.1
Host: 
Authorization: text
Accept: */*
{
  "status": 1,
  "message": "text"
}
GET /permission-module/permission-me HTTP/1.1
Host: 
Authorization: text
Accept: */*
{
  "status": 1,
  "message": "text"
}