User Tools

Site Tools


en-122-api-chck


API Request / CHCK

The CHCK command requests to the webservice, through POST, verify a user and its subscription code.



POST variables

id Contains the identification of the requester, no encrypted (Channel-ID);
key Contains the temporary AES key encrypted with the public key and encoded in Base64;
frame Contains the XML request, encrypted with the temporary AES key and encoded in Base64.



XML POST response

In response to the POST, the webservice returns the XML POST response, which should not mistaken with the XML request response, as described below. The POST response XML includes 3 tags:

<?xml version="1.0" encoding="utf-8"?>
<followzup>
<retcode>return-code</retcode>
<retframe>xml-request-response</retframe>
<retmd5>md5-hash</retmd5>
</followzup>

where:

  • retcode: Return code of the requested command represented by 4 numeric digits or “0” (zero) for successfully execution;
  • retframe: Contains the XML request response, encrypted with the temporary key AES and encoded in Base64. The XML request response depends on the command that was requested and the AES key used in its encryption is the same were used when the request was sent;
  • retmd5: Contains the MD5 hash of the retframe tag, to be validated by the requester.



XML request

<?xml version="1.0" encoding="utf-8"?>
<followzup>
<com>chck</com>
<seq>sequence</seq>
<urs>user-identification</urs>
<sub>subscription-code</sub>
</followzup>

Where:

  • chck: Must contain the literal “chck” (Check User);
  • sequence: Contains the request sequence number;
  • user-identification: E-mail or User-ID of the user to be verified;
  • subscription-code: The subscription code to be verified.



XML request response

<?xml version="1.0" encoding="utf-8"?>
<followzup>
<uid>USER-ID</uid>
<reg>yes|no</reg>
</followzup>

Where:

  • USER-ID: Internal user code of the verifie user;
  • yes|no: Flag YES = registered user, NO = anonymous user.


XML request response (invalid sequence):

<?xml version="1.0" encoding="utf-8"?>
<followzup>
<seq>Last-sequence</seq>
</followzup>

Where:

  • Last-sequence: Sequence number used in the last request.



Return codes

0 Successfully execution
6101 Invalid sequence (handled by API)
6102 Invalid frame
6103 Invalid command
6104 Invalid Channel-ID
6106 Invalid user
6203 User is not a channel subscriber
6204 Subscription code does not match
6999 Webservice under maintenance


en-122-api-chck.txt · Last modified: 2017/05/30 09:47 by admin

Page Tools