Open main menu

Authentication

Contents

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