Skip to content

Config


API Request

Request URL

POST

https://{host}/api/rentbox/client/config?rentboxSN={rentboxSN}&sign={sign} 

text
/api/rentbox/client/config
text
Content-Type:text/plain

Request Parameters

NameIdentification codeIs it requiredRemarks
Server domain namehostYESProvided by the customer, for example: s.abc.com
Globally unique device coderentboxSNYES4G communication module, IMEI number
Interface signaturesignYESMD5 encryption

Body

Equipment debugging information, no need to pay attention to customer docking

json
{
    "APN":"AT+QICSGP=1,1,\"3gnet\",\"\",\"\",0",
    "soft":"V6089",
    "hard":"V2004",
    "CRC16":"0x240D",
    "EC20_Mead":"Quectel",
    "EC20_Type":"EC200N",
    "EC20_Version":"EC200NCNLAR03A02M08_DO"
}

Interface signature

text
sign=MD5("rentboxSN={rentboxSN}")

API Example

text
Content-Type:text/plain

Body

{"APN":"AT+QICSGP=1,1,"3gnet","","",0","soft":"V6089","hard":"V2004","CRC16":"0x240D","EC20_Mead":"Quectel","EC20_Type":"EC200N","EC20_Version":"EC200NCNLAR03A02M08_DO"}

sign = 005dca9b80163313e88f249763ac96e9

MD5("rentboxSN=860602069165357")

API Response

json
{
    "code":200,
    "type":0,
    "data":"{\"dRotationRefer\":\"15\",\"dReturnLocked\":\"0\",\"dHeadConfig\":\"43\",\"dRotationNumber\":\"4\",\"dRotationEnable\":\"1\",\"dMotorEnable\":\"1\",\"dAreaConfig\":\"4\"}",
    "msg":"OK",
    "time":1705479269271
}
NameIdentification codeTypeRemarks
status codecodeintDefault: 200
status typetypeintDefault: 0
Custom datadatastringConfiguration parameters, strings need to be escaped JSON objects
Exception messagemsgstringDefault: OK
timestamptimelongcurrent millisecond timestamp

Configuration Parameters

json
{
    "dRotationRefer":"15",
    "dReturnLocked":"0",
    "dHeadConfig":"43",
    "dRotationNumber":"4",
    "dRotationEnable":"0",
    "dMotorEnable":"0",
    "dAreaConfig":"0"
}
NameIdentification codeTypeRemarks
dRotationReferdRotationReferstringCabinet self-test time (minutes): default 15
dReturnLockeddReturnLockedstringReserved value: default 0
dHeadConfigdHeadConfigstringReserved value: default 43
dRotationNumberdRotationNumberstringReserved value: default 4
dRotationEnabledRotationEnablestringReserved value: default 0
dMotorEnabledMotorEnablestringReserved value: default 0
dAreaConfigdAreaConfigstringArea code (customized), default 0