Authentication - Revision history

Admin at 15:38, 4 February 2026

2026-02-04T15:38:14Z

← Older revision		Revision as of 15:38, 4 February 2026
Line 4:		Line 4:
	{{#seo:		{{#seo:
	\|title=Authentication - SimplyBook.me		\|title=Authentication - SimplyBook.me
	\|description=~~Add~~ authentication ~~for~~ secure ~~access to your booking system~~. ~~Protect client and business data~~. ~~Learn more about this feature!~~		\|description=Learn aPI authentication methods and security protocols. Implement access tokens, secure API calls. Technical documentation for developers integrating with .
	\|titlemode=append		\|titlemode=append
	\|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content		\|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content

Tania: Marked this version for translation

2025-05-15T13:11:02Z

Marked this version for translation

← Older revision		Revision as of 13:11, 15 May 2025
Line 1:		Line 1:
	<languages/>		<languages/>
	<translate>		<translate>
			<!--T:1-->
	{{#seo:		{{#seo:
	\|title=Authentication - SimplyBook.me		\|title=Authentication - SimplyBook.me
Line 10:		Line 11:

	<translate>		<translate>
	== Methods ==		== Methods == <!--T:2-->

	=== getServiceUrl ===		=== getServiceUrl === <!--T:3-->

			<!--T:4-->
	<code>getServiceUrl($companyLogin)</code>		<code>getServiceUrl($companyLogin)</code>

			<!--T:5-->
	Parameters:		Parameters:

			<!--T:6-->
	* '''$companyLogin''' String		* '''$companyLogin''' String

			<!--T:7-->
	Returns String.		Returns String.

			<!--T:8-->
	Returns API url for given company login		Returns API url for given company login

Line 27:		Line 33:
	----		----
	<translate>		<translate>
	=== getApplicationToken ===		=== getApplicationToken === <!--T:9-->

			<!--T:10-->
	<code>getApplicationToken($applicationApiKey)</code>		<code>getApplicationToken($applicationApiKey)</code>

			<!--T:11-->
	Parameters:		Parameters:

			<!--T:12-->
	* '''$applicationApiKey''' String		* '''$applicationApiKey''' String

			<!--T:13-->
	Returns String.		Returns String.

			<!--T:14-->
	Returns an application's token string for an application. You should use this token to authenticate all calls of		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		[[Company public service methods\|Company public service API methods]] and [[Catalogue\|Catalogue API methods]]. To
Line 44:		Line 55:
	----		----
	<translate>		<translate>
	=== getToken ===		=== getToken === <!--T:15-->

			<!--T:16-->
	<code>getToken($companyLogin, $apiKey)</code>		<code>getToken($companyLogin, $apiKey)</code>

			<!--T:17-->
	Parameters:		Parameters:

			<!--T:18-->
	* '''$companyLogin''' String		* '''$companyLogin''' String
	* '''$apiKey''' String		* '''$apiKey''' String

			<!--T:19-->
	Returns String.		Returns String.

			<!--T:20-->
	Returns an application's token string for a company. You should use this token to authenticate all calls of		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		[[Company public service methods\|Company public service API methods]] and [[Catalogue\|Catalogue API methods]]. To
Line 62:		Line 78:
	----		----
	<translate>		<translate>
	=== getUserToken ===		=== getUserToken === <!--T:21-->

			<!--T:22-->
	<code>getUserToken($companyLogin, $userLogin, $userPassword)</code>		<code>getUserToken($companyLogin, $userLogin, $userPassword)</code>

			<!--T:23-->
	Parameters:		Parameters:

			<!--T:24-->
	* '''$companyLogin''' String a company identifier (login)		* '''$companyLogin''' String a company identifier (login)
	* '''$userLogin''' String user's login associated with company		* '''$userLogin''' String user's login associated with company
	* '''$userPassword''' String user's password		* '''$userPassword''' String user's password

			<!--T:25-->
	Returns String.		Returns String.

			<!--T:26-->
	Returns an authentication token string for certain user registered for company. You should use this token to		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		authenticate all calls of [[Company administration service methods\|Company administration service API methods]] and
Line 80:		Line 101:

	<translate>		<translate>
	==Constants==		==Constants== <!--T:27-->

	=== Error codes ===		=== Error codes === <!--T:28-->

			<!--T:29-->
	See [[Errors handling]] for details.		See [[Errors handling]] for details.

			<!--T:30-->
	* -33001 Company does not exist		* -33001 Company does not exist
	* -33002 Wrong API key		* -33002 Wrong API key

Tania at 13:10, 15 May 2025

2025-05-15T13:10:48Z

← Older revision		Revision as of 13:10, 15 May 2025
Line 78:		Line 78:
	[[Catalogue\|Catalogue API methods]].		[[Catalogue\|Catalogue API methods]].
	</translate>		</translate>
	~~----~~
	<translate>		<translate>
	==Constants==		==Constants==

Tania at 13:10, 15 May 2025

2025-05-15T13:10:20Z

← Older revision		Revision as of 13:10, 15 May 2025
Line 1:		Line 1:
			<languages/>
			<translate>
	{{#seo:		{{#seo:
	\|title=Authentication - SimplyBook.me		\|title=Authentication - SimplyBook.me
Line 5:		Line 7:
	\|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content		\|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content
	}}		}}
			</translate>

			<translate>
	== Methods ==		== Methods ==

Line 21:		Line 24:
	Returns API url for given company login		Returns API url for given company login

			</translate>
	----		----
			<translate>
	=== getApplicationToken ===		=== getApplicationToken ===

Line 38:		Line 41:
	get application API key please contact SimplyBook.me support team.		get application API key please contact SimplyBook.me support team.

			</translate>
	----		----
			<translate>
	=== getToken ===		=== getToken ===

Line 56:		Line 59:
	get application API key you need to enable [[Custom_Features#API\|API Custom Feature]].		get application API key you need to enable [[Custom_Features#API\|API Custom Feature]].

			</translate>
	----		----
			<translate>
	=== getUserToken ===		=== getUserToken ===

Line 74:		Line 77:
	authenticate all calls of [[Company administration service methods\|Company administration service API methods]] and		authenticate all calls of [[Company administration service methods\|Company administration service API methods]] and
	[[Catalogue\|Catalogue API methods]].		[[Catalogue\|Catalogue API methods]].
			</translate>
	----		----
			<translate>
	==Constants==		==Constants==

Line 88:		Line 91:
	* -33004 User is blocked		* -33004 User is blocked
	* -33005 You are not allowed to use this application when HIPAA Custom Feature is enabled		* -33005 You are not allowed to use this application when HIPAA Custom Feature is enabled
			</translate>

Admin at 15:48, 6 December 2024

2024-12-06T15:48:59Z

← Older revision		Revision as of 15:48, 6 December 2024
Line 1:		Line 1:
	{{#seo:		{{#seo:
	\|title=~~Frequently Asked Questions about the Popular Appointment Booking System Scheduler~~ SimplyBook.me		\|title=Authentication - SimplyBook.me
	\|description=Add authentication for secure access to your booking system. Protect client and business data. Learn more about this feature!		\|description=Add authentication for secure access to your booking system. Protect client and business data. Learn more about this feature!
	\|titlemode=append		\|titlemode=append

Admin at 15:45, 6 December 2024

2024-12-06T15:45:59Z

← Older revision		Revision as of 15:45, 6 December 2024
Line 1:		Line 1:
			{{#seo:
			\|title=Frequently Asked Questions about the Popular Appointment Booking System Scheduler SimplyBook.me
			\|description=Add authentication for secure access to your booking system. Protect client and business data. Learn more about this feature!
			\|titlemode=append
			\|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content
			}}


	== Methods ==		== Methods ==

Admin at 19:05, 26 December 2016

2016-12-26T19:05:52Z

← Older revision		Revision as of 19:05, 26 December 2016
Line 46:		Line 46:
	Returns an application's token string for a company. You should use this token to authenticate all calls of		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		[[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~~]].		get application API key you need to enable [[Custom_Features#API\|API Custom Feature]].


Line 79:		Line 79:
	* -33003 User with this login and password not found		* -33003 User with this login and password not found
	* -33004 User is blocked		* -33004 User is blocked
	* -33005 You are not allowed to use this application when HIPAA ~~Plugin~~ is enabled		* -33005 You are not allowed to use this application when HIPAA Custom Feature is enabled

Admin: /* Methods */

2016-04-29T14:31:39Z

Methods

@@ Line 1: / Line 1: @@
 == Methods ==
 === getApplicationToken ===
@@ Line 51: / Line 66: @@
 authenticate all calls of [[Company administration service methods|Company administration service API methods]] and
 [[Catalogue|Catalogue API methods]].
 ----

Admin at 16:29, 4 January 2016

2016-01-04T16:29:17Z

← Older revision		Revision as of 16:29, 4 January 2016
Line 11:		Line 11:
	Returns String.		Returns String.

	Returns application token by application ~~api~~ key		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 by company ~~login/api~~ key		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 ~~(session id) by~~ company ~~login, user login, user password~~		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

Admin: Created page with "== Methods == === getApplicationToken === `getApplicationToken($applicationApiKey)` Parameters: * '''$applicationApiKey''' String Returns String. Returns app..."

2016-01-04T16:05:55Z

Created page with "== Methods == === getApplicationToken === <code>getApplicationToken($applicationApiKey)</code> Parameters: * '''$applicationApiKey''' String Returns String. Returns app..."

New page

== Methods ==

=== getApplicationToken ===

<code>getApplicationToken($applicationApiKey)</code>

Parameters:

* '''$applicationApiKey''' String

Returns String.

Returns application token by application api key

----

=== getToken ===

<code>getToken($companyLogin, $apiKey)</code>

Parameters:

* '''$companyLogin''' String
* '''$apiKey''' String

Returns String.

Returns token by company login/api key

----

=== getUserToken ===

<code>getUserToken($companyLogin, $userLogin, $userPassword)</code>

Parameters:

* '''$companyLogin''' String
* '''$userLogin''' String
* '''$userPassword''' String

Returns String.

Returns token (session id) by company login, user login, user password

----

Authentication - Revision history

Admin at 15:38, 4 February 2026

Tania: Marked this version for translation

Tania at 13:10, 15 May 2025

Tania at 13:10, 15 May 2025

Admin at 15:48, 6 December 2024

Admin at 15:45, 6 December 2024

Admin at 19:05, 26 December 2016

Admin: /* Methods */

Admin at 16:29, 4 January 2016

Admin: Created page with "== Methods == === getApplicationToken === getApplicationToken($applicationApiKey) Parameters: * '''$applicationApiKey''' String Returns String. Returns app..."

Admin: Created page with "== Methods == === getApplicationToken === `getApplicationToken($applicationApiKey)` Parameters: * '''$applicationApiKey''' String Returns String. Returns app..."