Difference between revisions of "MOR API user balance update"
From Kolmisoft Wiki
Jump to navigationJump to search
Line 1: | Line 1: | ||
=Description= | |||
<!---This functionality is available from MOR 10---> | |||
[[MOR API]] for user balance update. This method increases/decreases users balance with specified amount of money. | |||
<br><br> | |||
=Usage= | |||
* Call: /api/user_balance_change | |||
* Methods: POST, GET(if allowed, not recomended) | |||
<br><br> | |||
===Parametres=== | |||
[[MOR API]] | * user_id - Users ID in MOR database, whose balance we want to change. '''Required'''. | ||
* u - username to login. '''Required'''. (The user which changes balance: admin/reseller, not the user himself!) | |||
* balance - new user balance. '''Required'''. | |||
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''user_id''', '''balance''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''. | |||
<br><br> | |||
===Request=== | |||
We have user_id = 123, API Secret Key = 456789, balance = 100 | |||
HTML POST: http://<SERVER IP>/api/user_balance_change?u=username&user_id=123&balance=100&hash=b1bef44691c237b574263e09b2838ad1e658e507 | |||
'''* Note that username and password are not included in hash''' | |||
<br><br> | |||
===Returns=== | |||
'''Success''' | |||
<page> | |||
<page> | |||
<status>User balance updated</status> | |||
<user> | |||
<username> username </username> | |||
<id> user_id </id> | |||
<balance> new balance </balance> | |||
</user> | |||
</page> | |||
</page> | |||
<br><br> | <br><br> | ||
---- | ---- | ||
'''Errors''' | |||
User was not found using user_id. Use correct user_id. | |||
<?xml version="1.0" encoding="UTF-8"?> | |||
<page> | |||
<error>User was not found</error> | |||
</page> | |||
Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string. | |||
<?xml version="1.0" encoding="UTF-8"?> | |||
<status> | |||
<error>Incorrect hash</error> | |||
</status> | |||
User not loged in the system. Check username and password. | |||
<?xml version="1.0" encoding="UTF-8"?> | |||
<page> | |||
<error>Bad login</error> | |||
</page> | |||
Params balance is not correct or user is not saved. Check balance param. | |||
<?xml version="1.0" encoding="UTF-8"?> | |||
<page> | |||
<error>User balance not updated</error> | |||
</page> | |||
<br><br> | <br><br> | ||
===Additional notes=== | |||
*If the balance is changed during the call, price for the call will be deducted from new balance, because balance is deducted at the end of call. | *If the balance is changed during the call, price for the call will be deducted from new balance, because balance is deducted at the end of call. | ||
<br><br> | <br><br> | ||
=See also= | |||
* [[MOR API]] | |||
* | |||
Revision as of 16:14, 23 May 2013
Description
MOR API for user balance update. This method increases/decreases users balance with specified amount of money.
Usage
- Call: /api/user_balance_change
- Methods: POST, GET(if allowed, not recomended)
Parametres
- user_id - Users ID in MOR database, whose balance we want to change. Required.
- u - username to login. Required. (The user which changes balance: admin/reseller, not the user himself!)
- balance - new user balance. Required.
- hash - SHA1 hash constructed using user_id, balance and API_Secret_Key ( More described in Constructing hash). Required.
Request
We have user_id = 123, API Secret Key = 456789, balance = 100
HTML POST: http://<SERVER IP>/api/user_balance_change?u=username&user_id=123&balance=100&hash=b1bef44691c237b574263e09b2838ad1e658e507
* Note that username and password are not included in hash
Returns
Success
<page> <page> <status>User balance updated</status> <user> <username> username </username> <id> user_id </id> <balance> new balance </balance> </user> </page> </page>
Errors
User was not found using user_id. Use correct user_id.
<?xml version="1.0" encoding="UTF-8"?> <page> <error>User was not found</error> </page>
Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
<?xml version="1.0" encoding="UTF-8"?> <status> <error>Incorrect hash</error> </status>
User not loged in the system. Check username and password.
<?xml version="1.0" encoding="UTF-8"?> <page> <error>Bad login</error> </page>
Params balance is not correct or user is not saved. Check balance param.
<?xml version="1.0" encoding="UTF-8"?> <page> <error>User balance not updated</error> </page>
Additional notes
- If the balance is changed during the call, price for the call will be deducted from new balance, because balance is deducted at the end of call.