Redirection

API’s that belong to this category deal with redirection functions like updating license and server configuration.

There are two sections with one API each:

• Redirection License
• Server Config

Redirection License

UpdateLicense

This API can be used to update the licensee name and license key on the AhsayCBS server for the redirector.

The settings can be found on the AhsayCBS web console at:

• System Settings > License > Redirector

URL

https://CBS.EXAMPLE.COM/rdr/api/json/UpdateLicense.do

Available Since Version: 9.1

Parameters

Return Values

Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LicenseeName":"Ahsay_Test_RDR",
	"LicenseKey":"qwerty-5jjM4+Sz-SCz68XG+J"
}

OUTPUT 1

{
	"Status":"OK",
	"Key":"qwerty-5jjM4+Sz-SCz68XG+J",
	"Deactivated":false,
	"Licensee":"Ahsay_Test_RDR"
}

OUTPUT 2

{
	"Status":"OK",
	"Key":"qwerty-5jjM4+Sz-SCz68XG+J",
	"Deactivated":false,
	"Info":"Internal Error 1012. Please press the [Update] button in license page to correct this problem. If the problem persists, please contact our technical support team to resolve this problem.",
	"Licensee":"Ahsay_Test_RDR"
}

OUTPUT 3

{
	"Status":"Error",
	"Message":"License key incorrect. Please try again"
}

OUTPUT 4

{
	"Status":"OK",
	"Key":"qwerty-5jjM4+Sz-SCz68XG+J",
	"Deactivated":false,
	"Info":"[OEM Liccense.checkLicTime] License expired on 2023-01-01. Backup server is stopped"
	"Licensee":"Ahsay_Test_RDR"
}

Server Config

UpdateServerConfig

This API can be used to update the Redirector module's setting.

The settings can be found on the AhsayCBS web console at:

• Redirection > Hosting a Redirector > Server Configuration

URL

https://CBS.EXAMPLE.COM/rdr/api/json/UpdateServerConfig.do

Available Since Version: 9.1

Parameters

Return Values

JSON Objects

Backup Servers

Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"BackupServers":[
		{
			"Id":"1",
			"Enabled":true,
			"HttpEnabled":false,
			"SslEnabled":true,
			"LoginName":"system",
			"Password":"system1",
			"Hostname":"rcvr.com",
			"HttpPort":80,
			"SslPort":443,
			"Class":"com.ahsay.cbs.rdr.config.system.EditServerConfigBean$BackupServerBean"
		}
	],
	"SkipDuplicateUserCheck":false,
	"EnabledRdrFreeTrial":true
}

OUTPUT

{
	"Status":"OK"
}