Difference between revisions of "MOR API reseller group create"

From Kolmisoft Wiki
Jump to navigationJump to search
 
(2 intermediate revisions by the same user not shown)
Line 12: Line 12:


Parameters which are '''included''' into hash:
Parameters which are '''included''' into hash:
* u - username for authentication.
* name - reseller Group name.
* name - reseller Group name.
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''params''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required''' (if setting '''Disable hash checking''' is not checked).
<br/><br/>
<br/><br/>
Parameters which are '''not included''' into hash:
Parameters which are '''not included''' into hash:
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''params above''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required''' (if setting '''Disable hash checking''' is not checked).
* u - username for authentication.
* rg_description - Reseller Group description.<br/><br/>
* rg_description - Reseller Group description.<br/><br/>
Following parameters describes if Reseller Group can use specific functionality. If value is equal to 1 then Group can use functionality and if not then can not.<br/>
Following parameters describes if Reseller Group can use specific functionality. If value is equal to 1 then Group can use functionality and if not then can not.<br/>

Latest revision as of 07:42, 30 July 2014

Description

MOR API Create new reseller group from parameters.

Usage

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



Parameters

Parameters which are included into hash:

  • name - reseller Group name.



Parameters which are not included into hash:

  • hash - SHA1 hash constructed using params above and API_Secret_Key ( More described in Constructing hash). Required (if setting Disable hash checking is not checked).
  • u - username for authentication.
  • rg_description - Reseller Group description.

Following parameters describes if Reseller Group can use specific functionality. If value is equal to 1 then Group can use functionality and if not then can not.

  • calling_cards - describes if Reseller Group can use Calling Cards.
  • call_shop - describes if Reseller Group can use Call Shop.
  • sms_addon - describes if Reseller Group can use Sms Addon.
  • payment_gateways - describes if Reseller Group can use Payment Gateways.
  • autodialer - describes if Reseller Group can use Autodialer.
  • pbx_functions - describes if Reseller Group can use Pbx Functions.



Request

HTML POST: http://<SERVER_IP>/api/reseller_group_create?u=admin&name=Another Reseller Group&rg_description=for test purposes&call_shop=1&calling_cards=0&sms_addon=1&payment_gateways=1&autodialer=0&pbx_functions=1&test=1&hash=sd5g16sd1g6s



Returns

Success

<page> 

 <status>
   <success>Reseller Group successfully created</success>
 </status>

</page>



Errors

  • <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
  • <error>Registration over API is disabled</error> - Setting: Settings->API->API allow Registration, is off. Turn on API allow Registration.
  • <error>Access Denied</error> - User with params u not found or params u not send. Enter correct username.
  • <error>Reseller Group Name must be specified</error> - Params name was not send. Enter correct name.
  • <error>Group name must be unique</error> - Params name is used in another Reseller Group. Enter another name.



See also

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