User API guide/uk - Revision history

Admin at 19:48, 16 February 2026

2026-02-16T19:48:12Z

← Older revision		Revision as of 19:48, 16 February 2026
Line 1:		Line 1:
	<languages/>		<languages/>
	~~<div class="mw-translate-fuzzy">~~		{{#seo: \|title=Посібник користувача API - SimplyBook.me \|description=Документація API SimplyBook.me для розробників. Інтегруйте систему бронювання з власним програмним забезпеченням. REST API-ендпоінти, автентифікація та приклади включені.\|titlemode=додати \|keywords=fAQ, поширені запитання, програмне забезпечення для бронювання, запитання щодо системи бронювання, онлайн-бронювання, програмне забезпечення для календаря, система бронювання, календар бронювання, програмне забезпечення для планування, онлайн-планування зустрічей, онлайн-планування, плагіни, настроювані функції, посилання на настроювану сторінку бронювання, доменне ім'я, настроюване доменне ім'я, настроювана URL-адреса }}
	{{#seo: \|title=Посібник користувача API - SimplyBook.me \|description=~~Використовуйте~~ API ~~користувача~~ SimplyBook.me для ~~створення розширених інтеграцій~~. ~~Дотримуйтесь нашого посібника для безпроблемного впровадження~~. ~~Дізнайтеся більше тут!~~ \|titlemode=додати \|keywords=fAQ, поширені запитання, програмне забезпечення для бронювання, запитання щодо системи бронювання, онлайн-бронювання, програмне забезпечення для календаря, система бронювання, календар бронювання, програмне забезпечення для планування, онлайн-планування зустрічей, онлайн-планування, плагіни, настроювані функції, посилання на настроювану сторінку бронювання, доменне ім'я, настроюване доменне ім'я, настроювана URL-адреса }}
	~~</div>~~
	<br><br>		<br><br>

FuzzyBot: Updating to match new version of source page

2026-02-16T19:46:57Z

Updating to match new version of source page

← Older revision		Revision as of 19:46, 16 February 2026
Line 1:		Line 1:
	<languages/>		<languages/>
			<div class="mw-translate-fuzzy">
	{{#seo: \|title=Посібник користувача API - SimplyBook.me \|description=Використовуйте API користувача SimplyBook.me для створення розширених інтеграцій. Дотримуйтесь нашого посібника для безпроблемного впровадження. Дізнайтеся більше тут! \|titlemode=додати \|keywords=fAQ, поширені запитання, програмне забезпечення для бронювання, запитання щодо системи бронювання, онлайн-бронювання, програмне забезпечення для календаря, система бронювання, календар бронювання, програмне забезпечення для планування, онлайн-планування зустрічей, онлайн-планування, плагіни, настроювані функції, посилання на настроювану сторінку бронювання, доменне ім'я, настроюване доменне ім'я, настроювана URL-адреса }}		{{#seo: \|title=Посібник користувача API - SimplyBook.me \|description=Використовуйте API користувача SimplyBook.me для створення розширених інтеграцій. Дотримуйтесь нашого посібника для безпроблемного впровадження. Дізнайтеся більше тут! \|titlemode=додати \|keywords=fAQ, поширені запитання, програмне забезпечення для бронювання, запитання щодо системи бронювання, онлайн-бронювання, програмне забезпечення для календаря, система бронювання, календар бронювання, програмне забезпечення для планування, онлайн-планування зустрічей, онлайн-планування, плагіни, настроювані функції, посилання на настроювану сторінку бронювання, доменне ім'я, настроюване доменне ім'я, настроювана URL-адреса }}
			</div>
	<br><br>		<br><br>

Admin at 12:24, 15 May 2025

2025-05-15T12:24:41Z

← Older revision		Revision as of 12:24, 15 May 2025
Line 24:		Line 24:


	= '''CLIENT API ([https://simplybook.me/api/doc#/admin ~~ДЕРЖАВНА СЛУЖБА~~]) АВТОРИЗАЦІЯ''' =		= '''CLIENT API ([https://simplybook.me/api/doc#/admin ADMIN]) АВТОРИЗАЦІЯ''' =
	<br><br>		<br><br>
	== '''Авторизація з боку клієнта''' ==		== '''Авторизація з боку клієнта''' ==

Admin: Created page with "Перевірте, чи активована функція «Категорії послуг» за допомогою [https://simplybook.me/en/api/doc#isPluginActivated isPluginActivated("event_category")]. Якщо так, то відобразіть список категорій [https://simplybook.me/en/api/doc#getCategoriesList getCategoriesList()]."

2025-05-15T12:20:35Z

Created page with "Перевірте, чи активована функція «Категорії послуг» за допомогою [https://simplybook.me/en/api/doc#isPluginActivated isPluginActivated("event_category")]. Якщо так, то відобразіть список категорій [https://simplybook.me/en/api/doc#getCategoriesList getCategoriesList()]."

← Older revision		Revision as of 12:20, 15 May 2025
Line 271:		Line 271:
	Викличте [https://simplybook.me/en/api/doc#book книгу ($eventId, $unitId, $date, $time, $clientData, $additional, $count, $batchId)], щоб зробити бронювання.		Викличте [https://simplybook.me/en/api/doc#book книгу ($eventId, $unitId, $date, $time, $clientData, $additional, $count, $batchId)], щоб зробити бронювання.

	~~<div lang="en" dir="ltr" class="mw-content-ltr">~~
	<br><br>		<br><br>
	~~</div>~~

Admin: Created page with "'''Приклад коду бронювання послуги та її підтвердження за допомогою секретного API-ключа'''

$additionalFields = array( '6740d3bce747107ddb9a789cbb78abf3' => 'value1', 'b0657bafaec7a2c9800b923f959f8163' => 'value2' ); $clientData = array( 'name' => 'Ім'я клієнта', 'email' => 'client@email.com', 'phone' => '+13152108338' ); $bookingsInfo = $client->..."

2025-05-15T12:20:34Z

Created page with "'''Приклад коду бронювання послуги та її підтвердження за допомогою секретного API-ключа''' <nowiki>$additionalFields = array( '6740d3bce747107ddb9a789cbb78abf3' => 'value1', 'b0657bafaec7a2c9800b923f959f8163' => 'value2' ); $clientData = array( 'name' => 'Ім'я клієнта', 'email' => 'client@email.com', 'phone' => '+13152108338' ); $bookingsInfo = $client->..."

← Older revision		Revision as of 12:20, 15 May 2025
Line 256:		Line 256:


	~~<div lang="en" dir="ltr" class="mw-content~~-~~ltr">~~		Якщо активовано будь-яку спеціальну функцію вибору співробітника [https://simplybook.me/en/api/doc#isPluginActivated isPluginActivated("any_unit")] і в масиві "unit_map" не встановлено спеціальний термін для пари "послуга-виконавець", то користувачеві слід дозволити вибрати будь-який варіант постачальника або вибрати постачальника вручну. Але ручний вибір виконавців не повинен бути можливим, якщо активовано [https://simplybook.me/en/api/doc#getCompanyParam getCompanyParam("any_unit__hide_other_units")].
	~~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~~.
	~~</div>~~


	~~<div lang="en" dir="ltr" class="mw-content-ltr">~~		Використовуйте [https://simplybook.me/en/api/doc#getStartTimeMatrix getStartTimeMatrix ($from як поточну дату, $to як поточну дату, $eventId, $unitId, $count як значення вибраних учасників)], щоб отримати доступні часові слоти для заданої дати. '''$unitId''' повинен бути нульовим, якщо вибрано опцію «Будь-який співробітник».
	~~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~~.
	~~</div>~~


	~~<div lang="en" dir="ltr" class="mw~~-~~content~~-~~ltr">~~		Якщо активний селектор «Будь-який співробітник» і було вибрано будь-якого співробітника, викличте [https://simplybook.me/en/api/doc#getAvailableUnits getAvailableUnits($eventId, $dateTime, $count)], щоб отримати доступний $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
	~~</div>~~



	~~<div lang="en" dir="ltr" class="mw-content-ltr">~~		Якщо активована функція «Налаштування форм для нових клієнтів», викличте функцію [https://simplybook.me/en/api/doc#isPluginActivated isPluginActivated("event_field")] [https://simplybook.me/en/api/doc#getAdditionalFields getAdditionalFields($eventId)], щоб отримати список полів, які клієнт повинен заповнити.
	~~If Intake Forms Custom Feature is activated~~ [https://simplybook.me/en/api/doc#isPluginActivated isPluginActivated("event_field")] ~~call~~ [https://simplybook.me/en/api/doc#getAdditionalFields getAdditionalFields($eventId)] ~~function to get list of fields for client to fill~~.
	~~</div>~~


	~~<div lang="en" dir="ltr" class="mw-content-ltr">~~		Викличте [https://simplybook.me/en/api/doc#book книгу ($eventId, $unitId, $date, $time, $clientData, $additional, $count, $batchId)], щоб зробити бронювання.
	~~Call~~ [https://simplybook.me/en/api/doc#book ~~book~~($eventId, $unitId, $date, $time, $clientData, $additional, $count, $batchId)] ~~to make a booking~~.
	~~</div>~~

	<div lang="en" dir="ltr" class="mw-content-ltr">		<div lang="en" dir="ltr" class="mw-content-ltr">
	<br><br>		<br><br>
	</div>		</div>

Admin: Created page with "Інший корисний метод, який може вам знадобитися, — calculateEndTime. Кожна послуга може мати свою тривалість, а також співробітники вашої компанії можуть мати різний графік роботи в різні дні. Тож за допомогою цього методу ви можете правильно показати клієнту дату та..."

2025-05-15T12:20:28Z

Created page with "Інший корисний метод, який може вам знадобитися, — calculateEndTime. Кожна послуга може мати свою тривалість, а також співробітники вашої компанії можуть мати різний графік роботи в різні дні. Тож за допомогою цього методу ви можете правильно показати клієнту дату та..."

← Older revision		Revision as of 12:20, 15 May 2025
Line 252:		Line 252:


	~~<div lang="en" dir="ltr" class="mw-content-ltr">~~		Отримати список послуг (подій) та виконавців (одиниць) за допомогою функцій [https://simplybook.me/en/api/doc#getEventList getEventList()] та [https://simplybook.me/en/api/doc#getUnitList getUnitList()]. Якщо для послуги доступний масив "unit_map", це означає, що ця послуга може бути надана тільки зазначеними виконавцями.
	~~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~~.
	~~</div>~~

Admin: Created page with "'''Ініціалізація JSON-RPC-клієнта'''.

this.client = new JSONRpcClient({ 'url': 'https://user-api.simplybook.me' + '/admin/', 'headers': { 'X-Company-Login': YOUR_COMPANY_LOGIN, 'X-User-Token': token }, 'onerror': function (error) {} });

"

2025-05-15T12:20:27Z

Created page with "'''Ініціалізація JSON-RPC-клієнта'''. <nowiki>this.client = new JSONRpcClient({ 'url': 'https://user-api.simplybook.me' + '/admin/', 'headers': { 'X-Company-Login': YOUR_COMPANY_LOGIN, 'X-User-Token': token }, 'onerror': function (error) {} });</nowiki> "

← Older revision		Revision as of 12:20, 15 May 2025
Line 249:		Line 249:


	~~<div lang="en" dir="ltr" class="mw-content-ltr">~~		Перевірте, чи активована функція «Категорії послуг» за допомогою [https://simplybook.me/en/api/doc#isPluginActivated isPluginActivated("event_category")]. Якщо так, то відобразіть список категорій [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()].
	~~</div>~~

Admin: Created page with "= '''ОТРИМАННЯ ДАНИХ З СЕРВЕРА SIMPLYBOOK''' =

Сторінка бронювання зазвичай є сторінкою, на якій клієнти вибирають необхідну послугу, співробітника та час зустрічі. Потім клієнт вводить контактну інформацію та підтверджує бронювання. Більш складні рішення можу..."

2025-05-15T12:20:26Z

Created page with "= '''ОТРИМАННЯ ДАНИХ З СЕРВЕРА SIMPLYBOOK''' = Сторінка бронювання зазвичай є сторінкою, на якій клієнти вибирають необхідну послугу, співробітника та час зустрічі. Потім клієнт вводить контактну інформацію та підтверджує бронювання. Більш складні рішення можу..."

← Older revision		Revision as of 12:20, 15 May 2025
Line 224:		Line 224:
	<br><br>		<br><br>

	~~<div lang="en" dir="ltr" class="mw-content-ltr">~~		'''Приклад коду для отримання форм для введення даних'''
	'''~~Code example of getting intake forms~~'''
	<br><br>		<br><br>
	<nowiki>$fields = $client->getAdditionalFields($eventId);		<nowiki>$fields = $client->getAdditionalFields($eventId);
	// ~~returns~~ - ~~array~~(~~array~~(		// повертає - масив(масив(
	// 'name' => 'b0657bafaec7a2c9800b923f959f8163', - ~~field name~~		// 'name' => 'b0657bafaec7a2c9800b923f959f8163', - назва поля
	// 'title' => 'Test digits', - ~~field title~~		// 'title' => 'Test digits', - назва поля
	// 'type' => 'digits', - ~~field type~~		// 'type' => 'digits', - тип поля
	// 'values' => null, - ~~available values for~~ select ~~field type~~		// 'values' => null, - доступні значення для поля типу select
	// 'default' => null, - ~~default value for field~~		// 'default' => null, - значення за замовчуванням для поля
	// 'is_null' => null, - ~~is filed nullable~~		// 'is_null' => null, - чи поле може бути нульовим
	// 'on_main_page' => 1,		// 'on_main_page' => 1,
	// 'pos' => 1, - ~~field position~~		// 'pos' => 1, - позиція поля
	// 'value' => null		// 'value' => null
	// )), ...)</nowiki>		// )), ...)</nowiki>
	<br><br><br>		<br><br><br>
	~~</div>~~

	~~<div lang="en" dir="ltr" class="mw-content-ltr">~~		= '''ПЕРСОНАЛЬНІ ФУНКЦІЇ SIMPLYBOOK''' =
	='''SIMPLYBOOK ~~CUSTOM FEATURES~~'''=
	<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~~.		Якщо ваша компанія потребує додаткових функцій, ви можете активувати деякі з наших додаткових функцій. Повний перелік функцій з докладним описом доступний в адміністративному інтерфейсі за посиланням «Custom Feature» (Додаткові функції). Після увімкнення необхідної функції будуть активовані відповідні методи API, які ви зможете використовувати у своєму коді.
	<br><br><br>		<br><br><br>
	='''~~BOOKING FUNCTIONALITY CODEFLOW~~'''=		= '''ФУНКЦІОНАЛЬНІСТЬ БРОНЮВАННЯ КОДОВИЙ ПОТІК''' =
	<br><br>		<br><br>
	~~Authorize in~~ Simplybook API ~~using~~ '''loginClient.getToken(companyLogin, apiKey);''' ~~function~~.		Авторизуйтесь в Simplybook API за допомогою функції '''loginClient.getToken(companyLogin, apiKey);'''.
	~~</div>~~

Admin: Created page with "if ($bookingsInfo->require_confirm) { foreach ($bookingsInfo->bookings as $booking) { $sign = md5($booking->id . $booking->hash . YOUR_API_SECRET_KEY); $result = $client->confirmBooking($booking->id, $sign); echo ' Confirm result '; var_dump($result); } }

"

2025-05-15T12:20:24Z

Created page with "if ($bookingsInfo->require_confirm) { foreach ($bookingsInfo->bookings as $booking) { $sign = md5($booking->id . $booking->hash . YOUR_API_SECRET_KEY); $result = $client->confirmBooking($booking->id, $sign); echo ' Confirm result '; var_dump($result); } }</nowiki> "

← Older revision		Revision as of 12:20, 15 May 2025
Line 212:		Line 212:
	$bookingsInfo = $client->book($eventId, $unitId, $date, $time, $clientData, $additionalFields);		$bookingsInfo = $client->book($eventId, $unitId, $date, $time, $clientData, $additionalFields);

	~~<div lang="en" dir="ltr" class="mw-content-ltr">~~		if ($bookingsInfo->require_confirm) {
	if ($bookingsInfo->require_confirm) {		foreach ($bookingsInfo->bookings as $booking) {
	foreach ($bookingsInfo->bookings as $booking) {		$sign = md5($booking->id . $booking->hash . YOUR_API_SECRET_KEY);
	$sign = md5($booking->id . $booking->hash . YOUR_API_SECRET_KEY);		$result = $client->confirmBooking($booking->id, $sign);
	$result = $client->confirmBooking($booking->id, $sign);		echo '
	echo '
	Confirm result		Confirm result
	';		';
	var_dump($result);		var_dump($result);
	}		}
	}</nowiki>		}</nowiki>
	<br><br>		<br><br>
	~~</div>~~

	<div lang="en" dir="ltr" class="mw-content-ltr">		<div lang="en" dir="ltr" class="mw-content-ltr">

Admin: Created page with "Коли клієнт натискає кнопку «Підтвердити бронювання», ви повинні викликати метод book. Це основна функція, яка виконує всі необхідні перевірки та реєструє нове бронювання в системі Simplybook. Вона бере інформацію про бронювання, дані клієнта, такі як ім'я та телефо..."

2025-05-15T12:20:23Z

Created page with "Коли клієнт натискає кнопку «Підтвердити бронювання», ви повинні викликати метод book. Це основна функція, яка виконує всі необхідні перевірки та реєструє нове бронювання в системі Simplybook. Вона бере інформацію про бронювання, дані клієнта, такі як ім'я та телефо..."

← Older revision		Revision as of 12:20, 15 May 2025
Line 198:		Line 198:
	<br><br>		<br><br>

	~~<div lang="en" dir="ltr" class="mw-content-ltr">~~		'''Приклад коду бронювання послуги та її підтвердження за допомогою секретного API-ключа'''
	'''~~Code example of service booking and its confirmation using secret~~ API ~~key~~'''
	<br><br>		<br><br>
	<nowiki>$additionalFields = array(		<nowiki>$additionalFields = array(
	'6740d3bce747107ddb9a789cbb78abf3' => 'value1',		'6740d3bce747107ddb9a789cbb78abf3' => 'value1',
	'b0657bafaec7a2c9800b923f959f8163' => 'value2'		'b0657bafaec7a2c9800b923f959f8163' => 'value2'
	);		);
	$clientData = array(		$clientData = array(
	'name' => '~~Client name~~',		'name' => 'Ім'я клієнта',
	'email' => 'client@email.com',		'email' => 'client@email.com',
	'phone' => '+13152108338'		'phone' => '+13152108338'
	);		);

	$bookingsInfo = $client->book($eventId, $unitId, $date, $time, $clientData, $additionalFields);		$bookingsInfo = $client->book($eventId, $unitId, $date, $time, $clientData, $additionalFields);
	~~</div>~~

	<div lang="en" dir="ltr" class="mw-content-ltr">		<div lang="en" dir="ltr" class="mw-content-ltr">