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
Name | Identification code | Is it required | Remarks |
---|---|---|---|
Server domain name | host | YES | Provided by the customer, for example: s.abc.com |
Globally unique device code | rentboxSN | YES | 4G communication module, IMEI number |
Interface signature | sign | YES | MD5 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
}
Name | Identification code | Type | Remarks |
---|---|---|---|
status code | code | int | Default: 200 |
status type | type | int | Default: 0 |
Custom data | data | string | Configuration parameters, strings need to be escaped JSON objects |
Exception message | msg | string | Default: OK |
timestamp | time | long | current millisecond timestamp |
Configuration Parameters
json
{
"dRotationRefer":"15",
"dReturnLocked":"0",
"dHeadConfig":"43",
"dRotationNumber":"4",
"dRotationEnable":"0",
"dMotorEnable":"0",
"dAreaConfig":"0"
}
Name | Identification code | Type | Remarks |
---|---|---|---|
dRotationRefer | dRotationRefer | string | Cabinet self-test time (minutes): default 15 |
dReturnLocked | dReturnLocked | string | Reserved value: default 0 |
dHeadConfig | dHeadConfig | string | Reserved value: default 43 |
dRotationNumber | dRotationNumber | string | Reserved value: default 4 |
dRotationEnable | dRotationEnable | string | Reserved value: default 0 |
dMotorEnable | dMotorEnable | string | Reserved value: default 0 |
dAreaConfig | dAreaConfig | string | Area code (customized), default 0 |