MOR API CLI info get

From Kolmisoft Wiki
Revision as of 12:44, 29 March 2013 by Aisteb (talk | contribs)
Jump to navigationJump to search

MOR API CLI get info


  • Call: /api/cli_get_info
  • Params:
    • u – username to login. Required.
    • p – password to login. Required.
    • cli – this specifies CLI number whose info to show.
    • hash – SHA1 hash constructed using user_id and API_Secret_Key ( More described in Constructing hash). Required.


Returning XML is put in file. That file is gziped and returned as a response content.

Please note that admin/reseller can retrieve CLI info just for their own Users Devices.


  • Errors:
    • <error>CLI not found</error> – CLI was not found.
    • <error>CLI is empty</error> – CLI was not sent.
    • <error>Bad login</error> – User was not found by username and password. Use correct username and password. Make sure that username (u) and password (p) are specified.
    • <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
  • Returns:
<page>
  <cli>
    <device>
      <user_id>2</user_id>
      <device_id>2</device_id>
     </device>
   </cli>
</page>




  • Example:
    • We have API Secret Key = 456789, user_id = 12345
    • Hash string to be converted: "100456789"
    • We send:
      • /api/cli_get_info?u=admin&p=admin&cli=12345&hash=71516eea4850f7e0300ac86adf9fb64bca845aa7

* Note that username and password are not included in hash

See also