User API guide - Revision history

Admin at 19:46, 16 February 2026

2026-02-16T19:46:39Z

← Older revision		Revision as of 19:46, 16 February 2026
Line 4:		Line 4:
	{{#seo:		{{#seo:
	\|title=User API guide - SimplyBook.me		\|title=User API guide - SimplyBook.me
	\|description=~~Use the~~ SimplyBook.me ~~User~~ API ~~to create advanced integrations~~. ~~Follow our guide for seamless implementation~~. ~~Learn more here!~~		\|description=SimplyBook.me API documentation for developers. Integrate booking system with custom software. REST API endpoints, authentication, examples included.
	\|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, plugins, custom features, custom booking page link, domain name, custom domain name, custom url		\|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, plugins, custom features, custom booking page link, domain name, custom domain name, custom url

Admin: Marked this version for translation

2025-05-15T12:19:49Z

Marked this version for translation

Show changes

Admin at 12:19, 15 May 2025

2025-05-15T12:19:39Z

Show changes

Admin at 12:14, 15 May 2025

2025-05-15T12:14:58Z

← Older revision		Revision as of 12:14, 15 May 2025
Line 9:		Line 9:
	}}		}}
	</translate>		</translate>
	<br~~><be~~>		<br>

	<translate>		<translate>
Line 20:		Line 20:
	<!--T:4-->		<!--T:4-->
	See [https://simplybook.me/api_example/index.html an example of API-based booking interface], and also read [https://simplybook.me/api_example/scheduler.js the source code] of this solution.		See [https://simplybook.me/api_example/index.html an example of API-based booking interface], and also read [https://simplybook.me/api_example/scheduler.js the source code] of this solution.
	<br><br~~><be~~>		<br><br>

	</translate>		</translate>
Line 126:		Line 126:
	)		)
	));</nowiki>		));</nowiki>
	<br><br~~><be~~>		<br><br>

	</translate>		</translate>
Line 143:		Line 143:
	<!--T:11-->		<!--T:11-->
	So the first thing you should display is the list of services and the list of employes. Get this data by getEventList and getUnitList methods. They both return a list with complete information about each item in it, so you have many possibilities how to display services and employees at your page. To make employee filtration use unit_map property of the service list, it contains the info about employees who can provide the selected service.		So the first thing you should display is the list of services and the list of employes. Get this data by getEventList and getUnitList methods. They both return a list with complete information about each item in it, so you have many possibilities how to display services and employees at your page. To make employee filtration use unit_map property of the service list, it contains the info about employees who can provide the selected service.
	<br~~><be~~>		<br>

	</translate>		</translate>
Line 182:		Line 182:
	// 'qty' => 1, performer quantity		// 'qty' => 1, performer quantity
	// ), ...)</nowiki>		// ), ...)</nowiki>
	<br~~><be~~>		<br>

	</translate>		</translate>
Line 190:		Line 190:
	<!--T:13-->		<!--T:13-->
	The next step to a client is to pick a date and time of his service. We've used a Bootstrap date-picker in API-usage example, you can also use this or any other calendar. To set your calendar first date use getFirstWorkingDay method. It can take employee id as a parameter and returns the next date when the selected employee (or any employee in the company by default) is avaiable for booking. To show time slots inside a selected date you need getWorkCalendar and getStartTimeMatrix methods. The first method give you an information about working day start and end time, and about day-offs. And the second one returns the list of time-slots which can be booked for a certain date.		The next step to a client is to pick a date and time of his service. We've used a Bootstrap date-picker in API-usage example, you can also use this or any other calendar. To set your calendar first date use getFirstWorkingDay method. It can take employee id as a parameter and returns the next date when the selected employee (or any employee in the company by default) is avaiable for booking. To show time slots inside a selected date you need getWorkCalendar and getStartTimeMatrix methods. The first method give you an information about working day start and end time, and about day-offs. And the second one returns the list of time-slots which can be booked for a certain date.
	<br~~><be~~>		<br>

	</translate>		</translate>
Line 208:		Line 208:
	// ...		// ...
	//);</nowiki>		//);</nowiki>
	<br~~><be~~>		<br>

	</translate>		</translate>
Line 227:		Line 227:
	// '2015-03-04' => array('09:00:00', '09:30:00', '10:00:00', ....),		// '2015-03-04' => array('09:00:00', '09:30:00', '10:00:00', ....),
	//);</nowiki>		//);</nowiki>
	<br>~~<be>~~		<br>

	</translate>		</translate>

Line 235:		Line 234:
	<!--T:16-->		<!--T:16-->
	Another usefull method you may need is calculateEndTime. Each service can have its own duration, also your company's employees possible have different work schedule form day to day. So using this method you can show to a client an end date and time of the service he've booked in a correct way.		Another usefull method you may need is calculateEndTime. Each service can have its own duration, also your company's employees possible have different work schedule form day to day. So using this method you can show to a client an end date and time of the service he've booked in a correct way.
	<br~~><be~~>		<br>

	</translate>		</translate>
Line 250:		Line 249:
	// returns '2015-03-03 10:00:00'		// returns '2015-03-03 10:00:00'
	</nowiki>		</nowiki>
	<br~~><be~~>		<br>

	</translate>		</translate>
Line 258:		Line 257:
	<!--T:18-->		<!--T:18-->
	When a client clicks confirm booking button you have to call book method. This is the main function which performs all necessary validations and registers a new booking in Simplybook system. It takes information about booking, client data like name and phone and some additional params. See all params descriptions of this method in [https://simplybook.me/api/doc API functions list]. The book method responce contains an uniqe code and other details of the new booking or the list of errors if some problems occured, so you can use this information to show booking result to a client in convinient and intuitive way.		When a client clicks confirm booking button you have to call book method. This is the main function which performs all necessary validations and registers a new booking in Simplybook system. It takes information about booking, client data like name and phone and some additional params. See all params descriptions of this method in [https://simplybook.me/api/doc API functions list]. The book method responce contains an uniqe code and other details of the new booking or the list of errors if some problems occured, so you can use this information to show booking result to a client in convinient and intuitive way.
	<br><br~~><be~~>		<br><br>

	</translate>		</translate>
Line 268:		Line 267:
	<br><br>		<br><br>
	In some cases the book method may require the confirmation, e.g. if your accept payments from clients you confirm booking only after the payment is already came. The Simplybook API confirmBookng method takes booking-id and secure signature as params (another method which requires secure signature is cancelBookng). For the secure signature generation your secret API-key should be used. See how it can be done in the example below. You can find the secret key at admin interface under 'Settings' link of API Custom Feature in 'Custom Features' list.		In some cases the book method may require the confirmation, e.g. if your accept payments from clients you confirm booking only after the payment is already came. The Simplybook API confirmBookng method takes booking-id and secure signature as params (another method which requires secure signature is cancelBookng). For the secure signature generation your secret API-key should be used. See how it can be done in the example below. You can find the secret key at admin interface under 'Settings' link of API Custom Feature in 'Custom Features' list.
	<br~~><be~~>		<br>

	</translate>		</translate>
Line 300:		Line 299:
	}		}
	}</nowiki>		}</nowiki>
	<br~~><be~~>		<br>

	</translate>		</translate>
Line 321:		Line 320:
	// 'value' => null		// 'value' => null
	// )), ...)</nowiki>		// )), ...)</nowiki>
	<br><br~~><be~~>		<br><br>

	</translate>		</translate>
Line 331:		Line 330:
	<br><br>		<br><br>
	If your company specific requires some additional functionality you can activate some of our additional Custom Features. The complete Custom Features list with detailed description is avaiable in your admin interface under the 'Custom Feature' link. After the necessary Custom Feature is enabled the corresponding API methods will be activated so you can use them in your code.		If your company specific requires some additional functionality you can activate some of our additional Custom Features. The complete Custom Features list with detailed description is avaiable in your admin interface under the 'Custom Feature' link. After the necessary Custom Feature is enabled the corresponding API methods will be activated so you can use them in your code.
	<br><br~~><be~~>		<br><br>

	</translate>		</translate>
Line 377:		Line 376:

	<!--T:32-->		<!--T:32-->
	<br~~><be~~>		<br>

	</translate>		</translate>

Tania: Marked this version for translation

2025-05-15T12:06:34Z

Marked this version for translation

Show changes

Tania at 12:05, 15 May 2025

2025-05-15T12:05:31Z

← Older revision		Revision as of 12:05, 15 May 2025
Line 308:		Line 308:
	<br><br>		<br><br>
	If your company specific requires some additional functionality you can activate some of our additional Custom Features. The complete Custom Features list with detailed description is avaiable in your admin interface under the 'Custom Feature' link. After the necessary Custom Feature is enabled the corresponding API methods will be activated so you can use them in your code.		If your company specific requires some additional functionality you can activate some of our additional Custom Features. The complete Custom Features list with detailed description is avaiable in your admin interface under the 'Custom Feature' link. After the necessary Custom Feature is enabled the corresponding API methods will be activated so you can use them in your code.
	<br><br><br>		<br><br><be>
	~~='''BOOKING FUNCTIONALITY CODEFLOW'''=~~
	~~<br><br>~~
	~~Authorize in Simplybook API using '''loginClient.getToken(companyLogin, apiKey);''' function.~~

	</translate>		</translate>
Line 317:		Line 314:
	<translate>		<translate>

			='''BOOKING FUNCTIONALITY CODEFLOW'''=
			<br><br>
			Authorize in Simplybook API using '''loginClient.getToken(companyLogin, apiKey);''' function.

	Check if Service categories Custom Feature is activated by [https://simplybook.me/en/api/doc#isPluginActivated isPluginActivated("event_category")] if yes then display list of categories [https://simplybook.me/en/api/doc#getCategoriesList getCategoriesList()].		Check if Service categories Custom Feature is activated by [https://simplybook.me/en/api/doc#isPluginActivated isPluginActivated("event_category")] if yes then display list of categories [https://simplybook.me/en/api/doc#getCategoriesList getCategoriesList()].
Line 331:		Line 331:

	If Any Employee Selector Custom Feature is activated [https://simplybook.me/en/api/doc#isPluginActivated isPluginActivated("any_unit")] and no special duration is set for service-performer pair in "unit_map" array then user should be allowed to select Any provider option or choose provider manually. But manual selection of performers should not be possible if [https://simplybook.me/en/api/doc#getCompanyParam getCompanyParam("any_unit__hide_other_units")] is enabled.		If Any Employee Selector Custom Feature is activated [https://simplybook.me/en/api/doc#isPluginActivated isPluginActivated("any_unit")] and no special duration is set for service-performer pair in "unit_map" array then user should be allowed to select Any provider option or choose provider manually. But manual selection of performers should not be possible if [https://simplybook.me/en/api/doc#getCompanyParam getCompanyParam("any_unit__hide_other_units")] is enabled.

	~~</translate>~~

	~~<translate>~~

	Use [https://simplybook.me/en/api/doc#getStartTimeMatrix getStartTimeMatrix ($from as current date, $to as current date, $eventId, $unitId, $count as selected participants value )] to get available timeslots for given date. '''$unitId''' should be null if Any employee option is selected.		Use [https://simplybook.me/en/api/doc#getStartTimeMatrix getStartTimeMatrix ($from as current date, $to as current date, $eventId, $unitId, $count as selected participants value )] to get available timeslots for given date. '''$unitId''' should be null if Any employee option is selected.

	~~</translate>~~

	~~<translate>~~

	If Any Employee selector is active and Any employee was selected call [https://simplybook.me/en/api/doc#getAvailableUnits getAvailableUnits($eventId, $dateTime, $count)] to get available $unitId		If Any Employee selector is active and Any employee was selected call [https://simplybook.me/en/api/doc#getAvailableUnits getAvailableUnits($eventId, $dateTime, $count)] to get available $unitId

Tania at 12:02, 15 May 2025

2025-05-15T12:02:31Z

Show changes

Admin at 17:30, 16 January 2025

2025-01-16T17:30:39Z

← Older revision		Revision as of 17:30, 16 January 2025
Line 1:		Line 1:
			<languages/>
			<translate>
			{{#seo:
			\|title=User API guide - SimplyBook.me
			\|description=Use the SimplyBook.me User API to create advanced integrations. Follow our guide for seamless implementation. Learn more here!
			\|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, plugins, custom features, custom booking page link, domain name, custom domain name, custom url
			}}
			</translate>
	<br><br>		<br><br>
	Use our developer API to create your own booking interface. You can design any solution you want varying from the simplest widget to multifunctional application with functionality customized according to your business specific.		Use our developer API to create your own booking interface. You can design any solution you want varying from the simplest widget to multifunctional application with functionality customized according to your business specific.

Admin at 07:19, 12 February 2019

2019-02-12T07:19:01Z

← Older revision		Revision as of 07:19, 12 February 2019
Line 230:		Line 230:


	Get list of services (events) and performers (units) using [https://simplybook.me/en/api/doc#getEventList getEventList()] and [https://simplybook.me/en/api/doc#getUnitList ~~geUnitList~~()] functions. If "unit_map" array is available for service it means this service can be provided by given performers only.		Get list of services (events) and performers (units) using [https://simplybook.me/en/api/doc#getEventList getEventList()] and [https://simplybook.me/en/api/doc#getUnitList getUnitList()] functions. If "unit_map" array is available for service it means this service can be provided by given performers only.

Admin at 13:40, 22 January 2018

2018-01-22T13:40:20Z

← Older revision		Revision as of 13:40, 22 January 2018
Line 9:		Line 9:
	='''AUTHORIZATION'''=		='''AUTHORIZATION'''=
	<br><br>		<br><br>
	Using Simplybook API methods require an authentication. To authorize in Simplybook API you need to get an access key — access-token. In order to get this access-token you should call the JSON-RPC method getToken on ~~http~~://user-api.simplybook.me/login service passing your personal API-key. You can copy your API-key at admin interface: go to the 'Custom Features' link and select API Custom Feature 'Settings'. Then you have to init remote access to Simplybook API. Your request should contain the following headers: 'X-Company-Login', 'X-Token'.		Using Simplybook API methods require an authentication. To authorize in Simplybook API you need to get an access key — access-token. In order to get this access-token you should call the JSON-RPC method getToken on https://user-api.simplybook.me/login service passing your personal API-key. You can copy your API-key at admin interface: go to the 'Custom Features' link and select API Custom Feature 'Settings'. Then you have to init remote access to Simplybook API. Your request should contain the following headers: 'X-Company-Login', 'X-Token'.

	Getting the access-token can be implemented either from client side or from your server which is the more secure solution.		Getting the access-token can be implemented either from client side or from your server which is the more secure solution.
Line 25:		Line 25:
	<br><br>		<br><br>
	<nowiki>var loginClient = new JSONRpcClient({		<nowiki>var loginClient = new JSONRpcClient({
	'url': '~~http~~://user-api.simplybook.me' + '/login',		'url': 'https://user-api.simplybook.me' + '/login',
	'onerror': function (error) {},		'onerror': function (error) {},
	});		});
Line 33:		Line 33:
	<br><br>		<br><br>
	<nowiki>this.client = new JSONRpcClient({		<nowiki>this.client = new JSONRpcClient({
	'url': '~~http~~://user-api.simplybook.me',		'url': 'https://user-api.simplybook.me',
	'headers': {		'headers': {
	'X-Company-Login': YOUR_COMPANY_LOGIN,		'X-Company-Login': YOUR_COMPANY_LOGIN,
Line 44:		Line 44:
	<br><br>		<br><br>
	'''Getting the token-key.'''<br><br>		'''Getting the token-key.'''<br><br>
	<nowiki>$loginClient = new JsonRpcClient('~~http~~://user-api.simplybook.me' . '/login/');		<nowiki>$loginClient = new JsonRpcClient('https://user-api.simplybook.me' . '/login/');
	$token = $loginClient->getToken(YOUR_COMPANY_LOGIN, YOUR_API_KEY);</nowiki>		$token = $loginClient->getToken(YOUR_COMPANY_LOGIN, YOUR_API_KEY);</nowiki>
	<br><br>		<br><br>
	'''Initialization JSON-RPC-client.'''		'''Initialization JSON-RPC-client.'''
	<br><br>		<br><br>
	<nowiki>$client = new JsonRpcClient('~~http~~://user-api.simplybook.me' . '/', array(		<nowiki>$client = new JsonRpcClient('https://user-api.simplybook.me' . '/', array(
	'headers' => array(		'headers' => array(
	'X-Company-Login: ' . YOUR_COMPANY_LOGIN,		'X-Company-Login: ' . YOUR_COMPANY_LOGIN,
Line 63:		Line 63:
	<br><br>		<br><br>
	<nowiki>var loginClient = new JSONRpcClient({		<nowiki>var loginClient = new JSONRpcClient({
	'url': '~~http~~://user-api.simplybook.me' + '/login',		'url': 'https://user-api.simplybook.me' + '/login',
	'onerror': function (error) {},		'onerror': function (error) {},
	});		});
Line 71:		Line 71:
	<br><br>		<br><br>
	<nowiki>this.client = new JSONRpcClient({		<nowiki>this.client = new JSONRpcClient({
	'url': '~~http~~://user-api.simplybook.me' + '/admin/',		'url': 'https://user-api.simplybook.me' + '/admin/',
	'headers': {		'headers': {
	'X-Company-Login': YOUR_COMPANY_LOGIN,		'X-Company-Login': YOUR_COMPANY_LOGIN,
Line 83:		Line 83:
	'''Getting the token-key.'''		'''Getting the token-key.'''
	<br><br>		<br><br>
	<nowiki>$loginClient = new JsonRpcClient('~~http~~://user-api.simplybook.me' . '/login/');		<nowiki>$loginClient = new JsonRpcClient('https://user-api.simplybook.me' . '/login/');
	$token = $loginClient->getUserToken(YOUR_COMPANY_LOGIN, YOUR_USER_LOGIN, YOUR_USER_PASSWORD);</nowiki>		$token = $loginClient->getUserToken(YOUR_COMPANY_LOGIN, YOUR_USER_LOGIN, YOUR_USER_PASSWORD);</nowiki>
	<br><br>		<br><br>
	'''Initialization JSON-RPC-client.'''		'''Initialization JSON-RPC-client.'''
	<br><br>		<br><br>
	<nowiki>$client = new JsonRpcClient('~~http~~://user-api.simplybook.me' . '/admin/', array(		<nowiki>$client = new JsonRpcClient('https://user-api.simplybook.me' . '/admin/', array(
	'headers' => array(		'headers' => array(
	'X-Company-Login: ' . YOUR_COMPANY_LOGIN,		'X-Company-Login: ' . YOUR_COMPANY_LOGIN,