QR Master
1.Overview
The developer encapsulates the corresponding parameters as required to obtain the room card information。
2.Examples
| Language | Explanation | Download | Version |
|---|---|---|---|
| php | php_sdk instructions | Download SDK and DEMO | V2.0 |
| java | java_sdk instructions | Download SDK and DEMO | V2.0 |
| c# | c#_sdk instructions | Download SDK and DEMO | V2.0 |
3. Request URL
4. Request parameter format
/?c=Qrcode&a=getRoomCardInfo&sig={sig}
Sig is the encryption result of developer account SID and Auth Token, get details in Development documentation 。
HTTP request header:
Accept:application/json;
Content-Type:application/x-www-form-urlencode;charset=uft-8;
Authorization:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
{"communityNo":"1316880650","cardString":"DE0881195A049E684902BA7126E0EC333872125094454AAA397B03226720BA64D7E1FF2DF0500000200040055F"}
5. Parameter specification
| Attribute | Type | Constraint | Explanation |
|---|---|---|---|
| accountSid | String | Required | Developer Account SID, the unique identifier of developer(32 characters of letters and numbers). |
| sig | String | Required | Signature, API request required. |
| Accept | String | Required | Standard HTTP header, content-type: application/json |
| Content-Type | String | Required | Standard HTTP header, type:application/x-www-form-urlencode;charset=utf-8 |
| Authorization | String | Required | HTTP header authentication information |
| communityNo | String | Required | Community No. |
| cardString | String | Required | Room card qr code carries card string(The binary stream obtained by scanning the qr code is represented in hexadecimal) |
6. HTTP JSON request demo
HTTP header
Accept:application/json;
Content-Type:application/x-www-form-urlencode;charset=uft-8;
Authorization:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
{"communityNo":"1316880650","cardString":"DE0881195A049E684902BA7126E0EC333872125094454AAA397B03226720BA64D7E1FF2DF0500000200040055F"}
Http Requested parameters
/?c=Qrcode&a=getRoomCardInfo&sig=031A94222BB0AF73AA0DCDEB92D54609
Successful result。
{"错误":0,"data":{"buildernum":"001","buildername":"Building name","floornum":"001","floorname":"Floor name","roomnum":"003","roomname":"room","starttime":"2019-08-02 09:51:00","endtime":"2019-08-02 09:56:00","islost":"0","status":"1","holdermobile":"10000000000","holdername":"+86 10000000000","holderfromText":"QR Key","batchno":"000","cardTypeText":"GUEST"}}
Failure reason returning:
{ "status": 500, "info": "some 错误" }
7. XML request demo
HTTP header
Accept:application/xml;
Content-Type:application/x-www-form-urlencode;charset=uft-8;
Authorization:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
<?xml version='1.0' encoding='utf-8'?>
<Request>
<communityNo>1316880650</communityNo>
<cardString>DE0881195A049E684902BA7126E0EC333872125094454AAA397B03226720BA64D7E1FF2DF0500000200040055F</cardString>
</Request>
<Request>
<communityNo>1316880650</communityNo>
<cardString>DE0881195A049E684902BA7126E0EC333872125094454AAA397B03226720BA64D7E1FF2DF0500000200040055F</cardString>
</Request>
Http Requested parameters
/?c=Qrcode&a=getRoomCardInfo&sig=031A94222BB0AF73AA0DCDEB92D54609
Successful result。
<?xml version="1.0" encoding="UTF-8" ?>
<Response>
<status>200</status>
<info>success</info>
<data>{"buildernum":"001","buildername":"Building name","floornum":"001","floorname":"Floor name","roomnum":"003","roomname":"room","starttime":"2019-08-02 09:51:00","endtime":"2019-08-02 09:56:00","islost":"0","status":"1","holdermobile":"10000000000","holdername":"+86 10000000000","holderfromText":"QR Key","batchno":"000","cardTypeText":"GUEST"}</data>
</Response>
<Response>
<status>200</status>
<info>success</info>
<data>{"buildernum":"001","buildername":"Building name","floornum":"001","floorname":"Floor name","roomnum":"003","roomname":"room","starttime":"2019-08-02 09:51:00","endtime":"2019-08-02 09:56:00","islost":"0","status":"1","holdermobile":"10000000000","holdername":"+86 10000000000","holderfromText":"QR Key","batchno":"000","cardTypeText":"GUEST"}</data>
</Response>
Failure reason returning:
<?xml version="1.0" encoding="UTF-8" ?>
<Response>
<status>500</status>
<info> some 错误 </info>
</Response>
<Response>
<status>500</status>
<info> some 错误 </info>
</Response>