Authentication: Difference between revisions
Created page with "== Methods == === getApplicationToken === <code>getApplicationToken($applicationApiKey)</code> Parameters: * '''$applicationApiKey''' String Returns String. Returns app..." |
No edit summary |
||
| Line 11: | Line 11: | ||
Returns String. | Returns String. | ||
Returns application token | Returns an application's token string for an application. You should use this token to authenticate all calls of | ||
[[Company public service methods|Company public service API methods]] and [[Catalogue|Catalogue API methods]]. To | |||
get application API key please contact SimplyBook.me support team. | |||
| Line 27: | Line 29: | ||
Returns String. | Returns String. | ||
Returns token | Returns an application's token string for a company. You should use this token to authenticate all calls of | ||
[[Company public service methods|Company public service API methods]] and [[Catalogue|Catalogue API methods]]. To | |||
get application API key you need to enable [[Plugins#API|API plugin]]. | |||
| Line 38: | Line 42: | ||
Parameters: | Parameters: | ||
* '''$companyLogin''' String | * '''$companyLogin''' String a company identifier (login) | ||
* '''$userLogin''' String | * '''$userLogin''' String user's login associated with company | ||
* '''$userPassword''' String | * '''$userPassword''' String user's password | ||
Returns String. | Returns String. | ||
Returns token | Returns an authentication token string for certain user registered for company. You should use this token to | ||
authenticate all calls of [[Company administration service methods|Company administration service API methods]] and | |||
[[Catalogue|Catalogue API methods]]. | |||
---- | ---- | ||
==Constants== | |||
=== Error codes === | |||
See [[Errors handling]] for details. | |||
* -33001 Company does not exist | |||
* -33002 Wrong API key | |||
* -33003 User with this login and password not found | |||
* -33004 User is blocked | |||
* -33005 You are not allowed to use this application when HIPAA Plugin is enabled | |||