System

PreviousStore Settings NextUser and Permission

Last updated 4 months ago

Get Settings

get

Responses

200

Successfully got settings

get

GET /backend/api/settings HTTP/1.1
Host: 139.59.67.17
Accept: */*

200

Successfully got settings

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got settings</message>
</object>

Get list of users

get

Retrieves a list of users based on the provided parameters like limit, offset, and status.

Query parameters

limitintegerOptional

Limit of users per request

Default: 10

offsetintegerOptional

Offset to start fetching the list

Default: 0

countbooleanOptional

Whether to count the total number of users

Default: false

statusstringOptional

Filter users based on their status

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the user list

get

GET /backend/api/auth/userlist HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

200

Successfully retrieved the user list

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got all user list</message>
</object>

Retrieve audit log list

get

This endpoint is used to retrieve a list of audit logs with pagination and optional filters.

Query parameters

offsetintegerOptional

The number of items to skip (used for pagination)

Default: 0

limitintegerOptional

The number of items to return (used for pagination)

Default: 20

keywordstringOptional

Keyword to filter the results by

modulestringOptional

Filter the audit logs by the module

actionBystringOptional

Filter the audit logs by the user who performed the action

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved audit log list

400

Bad Request - Invalid input parameters

get

GET /backend/api/auditlog/auditLog-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got a audit log list</message>
</object>

Retrieve module log list

get

This endpoint is used to retrieve a list of modules involved in audit logs.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved module log list

400

Bad Request - Invalid request or input

get

GET /backend/api/auditlog/module-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got a module log list</message>
</object>

Update maintenance mode

put

This endpoint is used to enable or disable the maintenance mode.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

modeintegerRequired

Set mode: 0 to disable maintenance mode, 1 to enable maintenance mode.

Example: 0

idintegerRequired

The ID of the setting to update

Example: 2

Responses

200

Successfully updated the maintenance mode

400

Bad Request - Invalid input parameters

put

PUT /backend/api/settings/maintainance HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 17

"mode=0&id=2"

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Maintainance mode updated successfully</message>
</object>

Delete audit logs within a specified date range

post

This endpoint allows the deletion of audit logs between the given fromDate and toDate.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

fromDatestringRequired

The starting date for the range of audit logs to delete

Example: 2024-1-1

toDatestringRequired

The ending date for the range of audit logs to delete

Example: 2024-1-1

Responses

200

Successfully deleted the audit logs within the specified date range

400

Bad Request - Invalid input or date format

post

POST /backend/api/auditlog/delete-auditlog HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 43

"fromDate='2024-1-1'&toDate='2024-1-1'"

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully deleted audit logs</message>
</object>