Difference between revisions of "MOR API user logout"

From Kolmisoft Wiki
Jump to navigationJump to search
Line 9: Line 9:
<br><br>
<br><br>
===Parametres===
===Parametres===
* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using '''parameters''' which are listed above. You are able to use these parameter one by one or both at a time. If you use them both at a time note that parameters are shown in the same order as they have to be when generating the hash. Last parameter in a row is '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br>
* u – username. '''Required'''.
* u – username. '''Required'''.
<br><br>
<br><br>
===Request===
===Request===


  HTML POST: http://<SERVER_IP>/billing/api/user_logout?u=username
  HTML POST: http://<SERVER_IP>/billing/api/user_logout?u=username&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441
<br><br>
<br><br>
===Result===
===Result===

Revision as of 14:27, 24 March 2015

Description

MOR API Logs out user from MOR

Usage

  • From MOR X4 call: /api/user_logout
  • For Backwards-compatibility old name 'logout' is also usable. Call: /api/logout
  • Methods: POST, GET(if allowed, not recomended)



Parametres

  • hash - SHA1 hash constructed using parameters which are listed above. You are able to use these parameter one by one or both at a time. If you use them both at a time note that parameters are shown in the same order as they have to be when generating the hash. Last parameter in a row is API_Secret_Key ( More described in Constructing hash). Required.
  • u – username. Required.



Request

HTML POST: http://<SERVER_IP>/billing/api/user_logout?u=username&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441



Result

Success if User is logged out from the system.

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
 <action>
   <name>logout</name>
   <status>ok</status>
 </action>

Error.This means that wrong username and/or password and user can't be authenticated and logged out from the system.

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
 <action>
   <name>logout</name>
   <status>failed</status>
 </action>



See also