MOR API card from group sell

From Kolmisoft Wiki
Revision as of 13:55, 18 September 2017 by Reda (talk | contribs) (→‎Parametres)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

Description

MOR API sells Cards from Calling Card Group

Usage

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



Parametres

Parameters which are included into hash:

  • email - email address, to send information about bought card Optional.
  • id - Calling Card Group ID in MOR database. Required.
  • quantity - default 1. Optional.

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

Parameters which are not included into hash:

  • hash - SHA1 hash constructed using parameters above and API_Secret_Key ( More described in Constructing hash). Required.
  • u - username for authentication. Required.
  • number - parameter that indicates which card is sold. If number parameter is send, then quantity parameter will be ignored. Optional.
  • curr - parameter that lets change the currency of cards payment. Default currency is system currency. Optional.



Request

We have id = 6, quantity = 2, API Secret Key = 456789

We send:

HTML POST: http://<SERVER_IP>/billing/api/buy_card_from_callingroup?u=username&id=6&quantity=2&hash=37086d860581fabc278413cd1a417d5c079f6eba

NOTE that username are not included in hash

Returns

Success

<?xml version="1.0" encoding="UTF-8"?>
<page>
 <cards>
  <card>
    <pin>...</pin>
    <number>..</number>
    <balance_without_vat>...</balance_without_vat>
    <currency>...</currency>
  </card>
  <card>
    <pin>...</pin>
    <number>...</number>
    <balance_without_vat>...</balance_without_vat>
    <currency>...</currency>
  </card>
 </cards>
</page>




Errors

  • <error>Bad login</error> - User supplied bad login or password.
  • <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
  • <error>Cardgroup was not found</error> - Use correct Calling Card Group ID .
  • <error>Free cards was not found</error> - no free cards in Calling Card Group.
  • <error>Card is already sold</error> - This card is already sold.



See also