Difference between revisions of "API Configuration"
From Kolmisoft Wiki
Jump to navigationJump to search
| Line 5: | Line 5: | ||
* '''Allow API''' | * '''Allow API globally''' – should we enable API globaly? | ||
* '''Allow GET API''' | * '''Allow GET API''' – should we allow GET method to be used for API? Good for testing - but do not use in production! It is unsafe. | ||
* '''API Secret Key''' | * '''API Secret Key''' – key to [[MOR API hash construction | generate Hash]] | ||
* '''XML API Extension''' | * '''XML API Extension''' – send XML output with <HTML> tag - this is used for broken .Net support, keep it unchecked if everything works for you | ||
* '''Allow API Login Redirect''' | * '''Allow API Login Redirect''' – if login is successful the customer will be redirected to MOR billing Main site. | ||
* '''Disable hash checking''' | * '''Disable hash checking''' – When it is on API functions can be used without sending hash. Default value: off. | ||
* '''Uniquehash''' | * '''Uniquehash''' – admin's unique hash. Reseller can see it by going to '''SETTINGS''' -> '''Registration'''. | ||
'''NOTE''' that MOR does not allow you to enable '''Allow API''' if '''API Secret Key''' is not entered. In such case you will get a message '''Invalid API secret key'''. Enter '''API Secret Key''' in order to fix this. | |||
<br><br> | |||
=From Reseller/RSPRO = | |||
Reseller can use API functionality if '''Allow API globally''' in Admins settings is checked. | |||
Reseller has three options in his API Settings (Seetings –> API tab): | |||
* '''Allow API''' – turns on API functionality. | |||
* '''API Secret Key''' – key to [[MOR API hash construction | generate Hash]] | |||
* '''Disable hash checking''' – When it is on API functions can be used without sending hash. Default value: off. | |||
'''NOTE''' that Reseller also must enter '''API Secret Key''' if he want to use API functionality. | |||
<br><br> | <br><br> | ||
= See also = | = See also = | ||
* [[MOR API]] | * [[MOR API]] | ||
Revision as of 13:43, 19 May 2013
Go to SETTINGS –> Setup –> Settings –> API tab
- Allow API globally – should we enable API globaly?
- Allow GET API – should we allow GET method to be used for API? Good for testing - but do not use in production! It is unsafe.
- API Secret Key – key to generate Hash
- XML API Extension – send XML output with <HTML> tag - this is used for broken .Net support, keep it unchecked if everything works for you
- Allow API Login Redirect – if login is successful the customer will be redirected to MOR billing Main site.
- Disable hash checking – When it is on API functions can be used without sending hash. Default value: off.
- Uniquehash – admin's unique hash. Reseller can see it by going to SETTINGS -> Registration.
NOTE that MOR does not allow you to enable Allow API if API Secret Key is not entered. In such case you will get a message Invalid API secret key. Enter API Secret Key in order to fix this.
From Reseller/RSPRO
Reseller can use API functionality if Allow API globally in Admins settings is checked.
Reseller has three options in his API Settings (Seetings –> API tab):
- Allow API – turns on API functionality.
- API Secret Key – key to generate Hash
- Disable hash checking – When it is on API functions can be used without sending hash. Default value: off.
NOTE that Reseller also must enter API Secret Key if he want to use API functionality.
