QR Master
1.Overview
Developers send required parameters to server to disable QR code room card.
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=cancelCard&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
{"cardNo":"2EwNXzAmR9Voq67x","cardType":"0"}
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 |
| cardNo | String | Required | Unique room card No. |
| cardType | String | Optional | Key type (0: room card, 1: floor card, 2: building card, default 0 when not being transmitted). |
6. HTTP JSON request demo
HTTP header
Accept:application/json;
Content-Type:application/x-www-form-urlencode;charset=uft-8;
Authorization:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
{"cardNo":"2EwNXzAmR9Voq67x","cardType":"0"}
Http Requested parameters
/?c=Qrcode&a=cancelCard&sig=031A94222BB0AF73AA0DCDEB92D54609
Successful result: users can't obtain this card.
{"status":200,"info":success"}
Failure reason returning:
{ "status": 403, "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>
<cardNo>2EwNXzAmR9Voq67x</cardNo>
<cardType>0</cardType>
</Request>
<Request>
<cardNo>2EwNXzAmR9Voq67x</cardNo>
<cardType>0</cardType>
</Request>
Http Requested parameters
/?c=Qrcode&a=cancelCard&sig=031A94222BB0AF73AA0DCDEB92D54609
Successful result: users can't obtain this card.
<?xml version="1.0" encoding="UTF-8" ?>
<Response>
<status>200</status>
<info>success</info>
</Response>
<Response>
<status>200</status>
<info>success</info>
</Response>
Failure reason returning:
<?xml version="1.0" encoding="UTF-8" ?>
<Response>
<status>4003</status>
<info> some 错误 </info>
</Response>
<Response>
<status>4003</status>
<info> some 错误 </info>
</Response>