Difference between revisions of "MOR API user logout"
From Kolmisoft Wiki
Jump to navigationJump to search
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
=Description= | |||
[[MOR API]] Logs out user from MOR | [[MOR API]] Logs out user from MOR | ||
<br><br> | |||
=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) | |||
<br><br> | |||
===Parametres=== | |||
* u – username. '''Required'''. | |||
* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using just one '''parameter''' - '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br> | |||
<br><br> | |||
===Request=== | |||
==Result== | HTML POST: http://<SERVER_IP>/billing/api/user_logout?u=username&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441 | ||
<br><br> | |||
===Result=== | |||
'''Success''' if User is logged out from the system. | |||
<?xml version="1.0" encoding="utf-8" standalone="yes"?> | <?xml version="1.0" encoding="utf-8" standalone="yes"?> | ||
| Line 12: | Line 27: | ||
<status>ok</status> | <status>ok</status> | ||
</action> | </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"?> | <?xml version="1.0" encoding="utf-8" standalone="yes"?> | ||
| Line 23: | Line 36: | ||
<status>failed</status> | <status>failed</status> | ||
</action> | </action> | ||
<br><br> | |||
=See also= | |||
* [[MOR API]] | |||
Latest revision as of 14:31, 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
- u – username. Required.
- hash - SHA1 hash constructed using just one parameter - API_Secret_Key ( More described in Constructing hash). 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>
