Difference between revisions of "MOR API voucher use"

From Kolmisoft Wiki
Jump to navigationJump to search
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
-
=Description=
=Description=
<!---This functionality is available in MOR X5 and MOR X6--->
<!---This functionality is available in MOR X5 and MOR X6--->
[[MOR API]] Voucher use
[[MOR API]] Voucher use


Please note that admin can delete his phonebooks and his users phonebooks.  
Please note that only admins users and admin can use this API.  
Users can delete only the phonebooks they created themselves


<br><br>
<br><br>
Line 17: Line 15:


* u – username to login. '''Required'''.
* u – username to login. '''Required'''.
* voucher_number – this specifies id of phonebook record which will be deleted. '''Required'''.
* voucher_number – this is number of voucher which will be used. '''Required'''.
* user_id - this is the id of the user whose balance will be updated. '''Optional'''
* user_id - this is the id of the user whose balance will be updated. '''Optional'''
* [[MOR API hash construction | hash]] – SHA1 hash constructed using '''voucher_number''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
* [[MOR API hash construction | hash]] – SHA1 hash constructed using '''voucher_number''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
Line 25: Line 23:
===Request===
===Request===


We have API Secret Key = 123456, voucher_number = 1234567890 <br />
We have API Secret Key = 123456, voucher_number = 10007 <br />
We send:
We send:


  HTML POST: http://<server_ip>/billing/api/voucher_use?u=admin&user_id=2&voucher_number=10007&test=1&hash= d180bb861a4ee06850bc2fe40e2b8d2ab369e27f
  HTML POST: http://<server_ip>/billing/api/voucher_use?u=admin&user_id=2&voucher_number=10007&test=1&hash=d180bb861a4ee06850bc2fe40e2b8d2ab369e27f  


'''* Note that username and password are not included in hash'''
'''* Note that username and password are not included in hash'''
Line 37: Line 35:
'''Success'''
'''Success'''


<page>
<page>
   <status>
   <status>
     <status>Voucher used to update balance</status>
     <status>Voucher used to update balance</status>
Line 50: Line 48:
     <payment_id>10</payment_id>
     <payment_id>10</payment_id>
   </status>
   </status>
</page>
</page>




Line 61: Line 59:
* <error>Vouchers Disabled</error> – Vouchers are disabled.
* <error>Vouchers Disabled</error> – Vouchers are disabled.
* <error>Access Denied</error> – username (u) is not admins user or admin.
* <error>Access Denied</error> – username (u) is not admins user or admin.
* <error>User was not found</error> – username (u) is admin and specified user_id is not available.
* <error>User was not found</error> – specified user via user_id does not exist or his owner is not admin
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
<br><br>
<br><br>

Latest revision as of 15:15, 4 March 2015

Description

MOR API Voucher use

Please note that only admins users and admin can use this API.



Usage

  • Call: /api/voucher_use
  • Methods: POST, GET(if allowed, not recomended)



Parametres

  • u – username to login. Required.
  • voucher_number – this is number of voucher which will be used. Required.
  • user_id - this is the id of the user whose balance will be updated. Optional
  • hash – SHA1 hash constructed using voucher_number and API_Secret_Key ( More described in Constructing hash). Required.



Request

We have API Secret Key = 123456, voucher_number = 10007
We send: 

HTML POST: http://<server_ip>/billing/api/voucher_use?u=admin&user_id=2&voucher_number=10007&test=1&hash=d180bb861a4ee06850bc2fe40e2b8d2ab369e27f

* Note that username and password are not included in hash

Returns

Success 

<page>
 <status>
   <status>Voucher used to update balance</status>
   <voucher_number>10007</voucher_number>
   <voucher_id>11</voucher_id>
   <credit_with_tax>20.0</credit_with_tax>
   <credit_without_tax>20.0</credit_without_tax>
   <currency>USD</currency>
   <credit_in_default_currency>20.0</credit_in_default_currency>
   <user_id>2</user_id>
   <balance_after_voucher_use>20.0</balance_after_voucher_use>
   <payment_id>10</payment_id>
 </status>
</page>




Errors

  • <error>Voucher was not found</error> – Voucher was not found (Might be expired or already used).
  • <error>Vouchers Disabled</error> – Vouchers are disabled.
  • <error>Access Denied</error> – username (u) is not admins user or admin.
  • <error>User was not found</error> – specified user via user_id does not exist or his owner is not admin
  • <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.



See also

Retrieved from "https://wiki.kolmisoft.com/index.php?title=MOR_API_voucher_use&oldid=19029"