Difference between revisions of "M4 API Configuration"
From Kolmisoft Wiki
Jump to navigationJump to search
| (3 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
Go to ''' | Go to '''MAINTENANCE –> Settings –> API SETTINGS''' tab | ||
* '''Allow API globally''' – should we enable API globaly? When it is disabled, all settings below are also disabled and not editable. | * '''Allow API globally''' – should we enable API globaly? When it is disabled, all settings below are also disabled and not editable. | ||
* '''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. | * '''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 [[MOR API hash construction | generate Hash]] | * '''API Secret Key''' – key to [[MOR API hash construction | 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. | * '''XML API Extension''' – send XML output with HTML tag - this is used for broken .Net support, keep it unchecked if everything works for you. | ||
| Line 9: | Line 8: | ||
* '''Disable hash checking''' – When it is on API functions can be used without sending hash. Default value: off. | * '''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'''. | * '''Uniquehash''' – admin's unique hash. Reseller can see it by going to '''SETTINGS''' -> '''Registration'''. | ||
'''NOTE''' that | '''NOTE''' that M2 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> | <br><br> | ||
= See also = | = See also = | ||
* [[ | * [[M4 API]] | ||
Latest revision as of 11:07, 28 November 2022
Go to MAINTENANCE –> Settings –> API SETTINGS tab
- Allow API globally – should we enable API globaly? When it is disabled, all settings below are also disabled and not editable.
- 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 M2 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.
