Difference between revisions of "Authentication"
(Created page with "== Methods == === getApplicationToken === <code>getApplicationToken($applicationApiKey)</code> Parameters: * '''$applicationApiKey''' String Returns String. Returns app...") |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
== Methods == | == Methods == | ||
| + | |||
| + | === getServiceUrl === | ||
| + | |||
| + | <code>getServiceUrl($companyLogin)</code> | ||
| + | |||
| + | Parameters: | ||
| + | |||
| + | * '''$companyLogin''' String | ||
| + | |||
| + | Returns String. | ||
| + | |||
| + | Returns API url for given company login | ||
| + | |||
| + | |||
| + | ---- | ||
=== getApplicationToken === | === getApplicationToken === | ||
| Line 11: | Line 26: | ||
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 44: | ||
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 [[Custom_Features#API|API Custom Feature]]. | ||
| Line 38: | Line 57: | ||
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 Custom Feature is enabled | ||
Latest revision as of 19:05, 26 December 2016
Methods
getServiceUrl
getServiceUrl($companyLogin)
Parameters:
- $companyLogin String
Returns String.
Returns API url for given company login
getApplicationToken
getApplicationToken($applicationApiKey)
Parameters:
- $applicationApiKey String
Returns String.
Returns an application's token string for an application. You should use this token to authenticate all calls of Company public service API methods and Catalogue API methods. To get application API key please contact SimplyBook.me support team.
getToken
getToken($companyLogin, $apiKey)
Parameters:
- $companyLogin String
- $apiKey String
Returns String.
Returns an application's token string for a company. You should use this token to authenticate all calls of Company public service API methods and Catalogue API methods. To get application API key you need to enable API Custom Feature.
getUserToken
getUserToken($companyLogin, $userLogin, $userPassword)
Parameters:
- $companyLogin String a company identifier (login)
- $userLogin String user's login associated with company
- $userPassword String user's password
Returns String.
Returns an authentication token string for certain user registered for company. You should use this token to authenticate all calls of Company administration service API methods and 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 Custom Feature is enabled
