Add-ons | Spurtcommerce

Spurtcommerce

Document API Reference Add-ons

Get complete list of languages

get

Query parameters

limitintegerOptional

Limit the number of results

offsetintegerOptional

Offset for pagination

countbooleanOptional

Count flag (should be 0 or true/false)

keywordstringOptional

Search keyword to filter the languages

statusintegerOptional

Filter languages by status (1 for active)

defaultLanguagebooleanOptional

Filter by default language

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the language list

get

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

200

Successfully retrieved the language list

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

Get the plugin list

get

This endpoint retrieves the list of available plugins.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the plugin list

404

No plugins found

get

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

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

Get plugin details

get

This endpoint retrieves the details of a specific plugin by its ID.

Path parameters

idintegerRequired

The ID of the plugin.

Query parameters

idintegerOptional

Optional query parameter for the plugin ID.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the plugin details

404

Plugin not found

get

GET /backend/api/plugins/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the plugin detail</message>
</object>

Update plugin status

put

This endpoint updates the status of a specific plugin.

Path parameters

idintegerRequired

The ID of the plugin to be updated.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

pluginStatusstringRequiredExample: 0

Responses

200

Successfully updated the plugin status

404

Plugin not found

put

PUT /backend/api/plugins/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 20

"pluginStatus='0'"

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully updated the plugin status</message>
</object>

Update PayPal payment settings

post

This endpoint updates PayPal settings, including client credentials and test mode.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

clientIdstringRequired

The client ID for PayPal API.

clientSecretstringRequired

The client secret for PayPal API.

isTestbooleanRequired

Flag to indicate if PayPal is in test mode.

Responses

200

Successfully updated the PayPal payment settings

400

Invalid request, missing required parameters

post

POST /backend/api/paypal-payment HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 55

"clientId='text'&clientSecret='text'&isTest=true"

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Paypal settings updated successfully</message>
</object>