Difference between revisions of "MOR API card group get"
From Kolmisoft Wiki
Jump to navigationJump to search
(→Usage) |
|||
Line 9: | Line 9: | ||
* Methods: POST, GET(if allowed, not recomended) | * Methods: POST, GET(if allowed, not recomended) | ||
<br><br> | <br><br> | ||
=== | ===Parameters=== | ||
Parameters which are '''included''' into hash: | Parameters which are '''included''' into hash: |
Latest revision as of 10:23, 31 August 2017
Description
MOR API Show Calling Card Group
Usage
- From MOR X4 call: /api/card_group_get
- For Backwards-compatibility old name 'show_calling_card_group' is also usable. Call: /api/show_calling_card_group
- Methods: POST, GET(if allowed, not recomended)
Parameters
Parameters which are included into hash:
- id - Calling Card Group ID in MOR database. Required.
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.
Request
We have id = 6, API Secret Key = 456789
We send:
HTML POST: http://<SERVER_IP>/billing/api/card_group_get?u=username&id=6&hash=67df827dec80a7241fb3fc4de22a90e62c5e8d93
NOTE that username is not included in hash
Returns
Success
<?xml version="1.0" encoding="UTF-8"?> <page> <cardgroup> <name>....</name> <iamge_link>/billing/cards/example.jpg</iamge_link> <description>...</description> <price>...</price> <price_with_tax>...</price_with_tax> <currency>...</currency> <free_cards_size>...</free_cards_size> <pin_length>....</pin_length> <number_length>....</number_length> </cardgroup> </page>
Errors
- <error>Bad login</error> - User supplied bad login.
- <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 .