User API guide/fr - Revision history

Admin at 19:47, 16 February 2026

2026-02-16T19:47:44Z

← Older revision		Revision as of 19:47, 16 February 2026
Line 1:		Line 1:
	<languages/>		<languages/>
	~~<div class="mw-translate-fuzzy">~~		{{#seo: \|title=Guide de l'API utilisateur - SimplyBook.me \|description=Documentation API SimplyBook.me pour les développeurs. Intégrez le système de réservation avec un logiciel personnalisé. Points de terminaison REST API, authentification et exemples inclus.\|titlemode=ajouter \|keywords=fAQ, questions fréquentes, logiciel de réservation, questions sur le système de rendez-vous, rendez-vous en ligne, logiciel de calendrier, système de réservation, calendrier de réservation, logiciel de planification, planification de rendez-vous en ligne, planification en ligne, plugins, fonctionnalités personnalisées, lien vers une page de réservation personnalisée, nom de domaine, nom de domaine personnalisé, URL personnalisée }}
	{{#seo: \|title=Guide de l'API utilisateur - SimplyBook.me \|description=~~Utilisez l'~~API ~~utilisateur~~ SimplyBook.me pour ~~créer des intégrations avancées~~. ~~Suivez notre guide pour une mise en œuvre transparente~~. ~~Pour en savoir plus~~, ~~cliquez ici !~~ \|titlemode=ajouter \|keywords=fAQ, questions fréquentes, logiciel de réservation, questions sur le système de rendez-vous, rendez-vous en ligne, logiciel de calendrier, système de réservation, calendrier de réservation, logiciel de planification, planification de rendez-vous en ligne, planification en ligne, plugins, fonctionnalités personnalisées, lien vers une page de réservation personnalisée, nom de domaine, nom de domaine personnalisé, URL personnalisée }}
	~~</div>~~
	<br><br>		<br><br>

FuzzyBot: Updating to match new version of source page

2026-02-16T19:46:52Z

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=Guide de l'API utilisateur - SimplyBook.me \|description=Utilisez l'API utilisateur SimplyBook.me pour créer des intégrations avancées. Suivez notre guide pour une mise en œuvre transparente. Pour en savoir plus, cliquez ici ! \|titlemode=ajouter \|keywords=fAQ, questions fréquentes, logiciel de réservation, questions sur le système de rendez-vous, rendez-vous en ligne, logiciel de calendrier, système de réservation, calendrier de réservation, logiciel de planification, planification de rendez-vous en ligne, planification en ligne, plugins, fonctionnalités personnalisées, lien vers une page de réservation personnalisée, nom de domaine, nom de domaine personnalisé, URL personnalisée }}		{{#seo: \|title=Guide de l'API utilisateur - SimplyBook.me \|description=Utilisez l'API utilisateur SimplyBook.me pour créer des intégrations avancées. Suivez notre guide pour une mise en œuvre transparente. Pour en savoir plus, cliquez ici ! \|titlemode=ajouter \|keywords=fAQ, questions fréquentes, logiciel de réservation, questions sur le système de rendez-vous, rendez-vous en ligne, logiciel de calendrier, système de réservation, calendrier de réservation, logiciel de planification, planification de rendez-vous en ligne, planification en ligne, plugins, fonctionnalités personnalisées, lien vers une page de réservation personnalisée, nom de domaine, nom de domaine personnalisé, URL personnalisée }}
			</div>
	<br><br>		<br><br>

Admin: Created page with "'''Exemple de code pour obtenir les formulaires d'inscription'''

$fields = $client->getAdditionalFields($eventId); // renvoie - array(array( // 'name' => 'b0657bafaec7a2c9800b923f959f8163', - nom du champ // 'title' => 'Test digits', - titre du champ // 'type' => 'digits', - type de champ // 'values' => null, - valeurs disponibles pour le type de champ de sélection // 'default' => null, - valeur par défaut pour le champ // 'is_..."

2025-05-15T12:23:27Z

Created page with "'''Exemple de code pour obtenir les formulaires d'inscription''' <nowiki>$fields = $client->getAdditionalFields($eventId); // renvoie - array(array( // 'name' => 'b0657bafaec7a2c9800b923f959f8163', - nom du champ // 'title' => 'Test digits', - titre du champ // 'type' => 'digits', - type de champ // 'values' => null, - valeurs disponibles pour le type de champ de sélection // 'default' => null, - valeur par défaut pour le champ // 'is_..."

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


	~~<div lang="en" dir="ltr" class="mw-content-ltr">~~		Si la fonctionnalité personnalisée des formulaires de saisie est activée, [https://simplybook.me/en/api/doc#isPluginActivated isPluginActivated("event_field")] appelle la fonction [https://simplybook.me/en/api/doc#getAdditionalFields getAdditionalFields($eventId)] pour obtenir la liste des champs à remplir par le client.
	~~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">~~		Appelez [https://simplybook.me/en/api/doc#book book($eventId, $unitId, $date, $time, $clientData, $additional, $count, $batchId)] pour effectuer une réservation.
	~~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">~~
	<br><br>		<br><br>
	~~</div>~~

Admin: Created page with "Utilisez [https://simplybook.me/en/api/doc#getStartTimeMatrix getStartTimeMatrix ($from comme date actuelle, $to comme date actuelle, $eventId, $unitId, $count comme valeur des participants sélectionnés)] pour obtenir les créneaux horaires disponibles pour une date donnée. '''$unitId''' doit être nul si l'option « Tout employé » est sélectionnée."

2025-05-15T12:23:22Z

Created page with "Utilisez [https://simplybook.me/en/api/doc#getStartTimeMatrix getStartTimeMatrix ($from comme date actuelle, $to comme date actuelle, $eventId, $unitId, $count comme valeur des participants sélectionnés)] pour obtenir les créneaux horaires disponibles pour une date donnée. '''$unitId''' doit être nul si l'option « Tout employé » est sélectionnée."

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


	~~<div lang="en" dir="ltr" class="mw-content-ltr">~~		Si le sélecteur « Any Employee » (Tout employé) est actif et qu'un employé a été sélectionné, appelez [https://simplybook.me/en/api/doc#getAvailableUnits getAvailableUnits($eventId, $dateTime, $count)] pour obtenir le $unitId disponible
	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>~~

Admin: Created page with "= '''API CLIENT ([https://simplybook.me/api/doc#/admin SERVICE PUBLIC DE L'ENTREPRISE]) AUTORISATION''' =

== '''Autorisation depuis le code côté client''' ==

'''Obtention de la clé token'''.

var loginClient = new JSONRpcClient({ 'url': 'https://user-api.simplybook.me' + '/login', 'onerror': function (error) {}, }); var token = loginClient.getToken(YOUR_COMPANY_LOGIN, YOUR_API_KEY);

'''Initialisation du client JSO..."

2025-05-15T12:23:21Z

Created page with "= '''API CLIENT ([https://simplybook.me/api/doc#/admin SERVICE PUBLIC DE L'ENTREPRISE]) AUTORISATION''' = == '''Autorisation depuis le code côté client''' == '''Obtention de la clé token'''. <nowiki>var loginClient = new JSONRpcClient({ 'url': 'https://user-api.simplybook.me' + '/login', 'onerror': function (error) {}, }); var token = loginClient.getToken(YOUR_COMPANY_LOGIN, YOUR_API_KEY);</nowiki> '''Initialisation du client JSO..."

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


	~~<div lang="en" dir="ltr" class="mw-content-ltr">~~		Si la fonctionnalité personnalisée Any Employee Selector est activée [https://simplybook.me/en/api/doc#isPluginActivated isPluginActivated("any_unit")] et qu'aucune durée particulière n'est définie pour la paire service-prestataire dans le tableau « unit_map », l'utilisateur doit pouvoir sélectionner l'option Any provider (Tout prestataire) ou choisir manuellement un prestataire. Cependant, la sélection manuelle des prestataires ne doit pas être possible si [https://simplybook.me/en/api/doc#getCompanyParam getCompanyParam("any_unit__hide_other_units")] est activé.
	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">~~		Utilisez [https://simplybook.me/en/api/doc#getStartTimeMatrix getStartTimeMatrix ($from comme date actuelle, $to comme date actuelle, $eventId, $unitId, $count comme valeur des participants sélectionnés)] pour obtenir les créneaux horaires disponibles pour une date donnée. '''$unitId''' doit être nul si l'option « Tout employé » est sélectionnée.
	~~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>~~

Admin: Created page with "= '''UTILISATION DE LA CLÉ SECRÈTE API''' =

Dans certains cas, la méthode de réservation peut nécessiter une confirmation, par exemple si vous acceptez les paiements de vos clients et que vous ne confirmez la réservation qu'après réception du paiement. La méthode confirmBookng de l'API Simplybook prend comme paramètres l'identifiant de la réservation et une signature sécurisée (une autre méthode qui nécessite une signature sécurisée est cancelBo..."

2025-05-15T12:23:18Z

Created page with "= '''UTILISATION DE LA CLÉ SECRÈTE API''' = Dans certains cas, la méthode de réservation peut nécessiter une confirmation, par exemple si vous acceptez les paiements de vos clients et que vous ne confirmez la réservation qu'après réception du paiement. La méthode confirmBookng de l'API Simplybook prend comme paramètres l'identifiant de la réservation et une signature sécurisée (une autre méthode qui nécessite une signature sécurisée est cancelBo..."

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


	~~<div lang="en" dir="ltr" class="mw-content-ltr">~~		Obtenir la liste des services (événements) et des prestataires (unités) à l'aide des fonctions [https://simplybook.me/en/api/doc#getEventList getEventList()] et [https://simplybook.me/en/api/doc#getUnitList getUnitList()]. Si le tableau « unit_map » est disponible pour un service, cela signifie que ce service ne peut être fourni que par les prestataires indiqués.
	~~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 "Lorsqu'un client clique sur le bouton « Confirmer la réservation », vous devez appeler la méthode « book ». Il s'agit de la fonction principale qui effectue toutes les validations nécessaires et enregistre une nouvelle réservation dans le système Simplybook. Elle récupère les informations relatives à la réservation, les données du client telles que son nom et son numéro de téléphone, ainsi que certains paramètres supplémentaires. Vous trouverez la desc..."

2025-05-15T12:23:17Z

Created page with "Lorsqu'un client clique sur le bouton « Confirmer la réservation », vous devez appeler la méthode « book ». Il s'agit de la fonction principale qui effectue toutes les validations nécessaires et enregistre une nouvelle réservation dans le système Simplybook. Elle récupère les informations relatives à la réservation, les données du client telles que son nom et son numéro de téléphone, ainsi que certains paramètres supplémentaires. Vous trouverez la desc..."

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


	~~<div lang="en" dir="ltr" class="mw-content-ltr">~~		Vérifiez si la fonctionnalité personnalisée Catégories de services est activée par [https://simplybook.me/en/api/doc#isPluginActivated isPluginActivated("event_category")]. Si oui, affichez la liste des catégories [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 "'''Exemple de code pour la réservation d'un service et sa confirmation à l'aide d'une clé API secrète'''

$additionalFields = array( '6740d3bce747107ddb9a789cbb78abf3' => 'value1', 'b0657bafaec7a2c9800b923f959f8163' => 'value2' ); $clientData = array( 'name' => 'Nom du client', 'email' => 'client@email.com', 'phone' => '+13152108338' ); $bookingsInfo = $client->book($eventId, $unitId, $date, $time, $clientData, $additionalF..."

2025-05-15T12:23:16Z

Created page with "'''Exemple de code pour la réservation d'un service et sa confirmation à l'aide d'une clé API secrète''' <nowiki>$additionalFields = array( '6740d3bce747107ddb9a789cbb78abf3' => 'value1', 'b0657bafaec7a2c9800b923f959f8163' => 'value2' ); $clientData = array( 'name' => 'Nom du client', 'email' => 'client@email.com', 'phone' => '+13152108338' ); $bookingsInfo = $client->book($eventId, $unitId, $date, $time, $clientData, $additionalF..."

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

	~~<div lang="en" dir="ltr" class="mw-content-ltr">~~		= '''FONCTIONNALITÉS PERSONNALISÉES 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.		Si votre entreprise a besoin de fonctionnalités supplémentaires, vous pouvez activer certaines de nos fonctionnalités personnalisées. La liste complète des fonctionnalités personnalisées avec une description détaillée est disponible dans votre interface d'administration sous le lien « Fonctionnalités personnalisées ». Une fois la fonctionnalité personnalisée nécessaire activée, les méthodes API correspondantes seront activées afin que vous puissiez les utiliser dans votre code.
	<br><br><br>		<br><br><br>
	='''~~BOOKING FUNCTIONALITY~~ CODEFLOW'''=		= '''FONCTIONNALITÉ DE RÉSERVATION CODEFLOW''' =
	<br><br>		<br><br>
	~~Authorize in~~ Simplybook ~~API using~~ '''loginClient.getToken(companyLogin, apiKey);''' ~~function~~.		Autorisez l'accès à l'API Simplybook à l'aide de la fonction '''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:23:16Z

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:23, 15 May 2025
Line 222:		Line 222:
	<br><br>		<br><br>

	~~<div lang="en" dir="ltr" class="mw-content-ltr">~~		'''Exemple de code pour obtenir les formulaires d'inscription'''
	'''~~Code example of getting intake forms~~'''
	<br><br>		<br><br>
	<nowiki>$fields = $client->getAdditionalFields($eventId);		<nowiki>$fields = $client->getAdditionalFields($eventId);
	// ~~returns~~ - array(array(		// renvoie - array(array(
	// 'name' => 'b0657bafaec7a2c9800b923f959f8163', - ~~field name~~		// 'name' => 'b0657bafaec7a2c9800b923f959f8163', - nom du champ
	// 'title' => 'Test digits', - ~~field title~~		// 'title' => 'Test digits', - titre du champ
	// 'type' => 'digits', - ~~field~~ type		// 'type' => 'digits', - type de champ
	// 'values' => null, - ~~available values for select field~~ type		// 'values' => null, - valeurs disponibles pour le type de champ de sélection
	// 'default' => null, - ~~default value for field~~		// 'default' => null, - valeur par défaut pour le champ
	// 'is_null' => null, - ~~is filed nullable~~		// 'is_null' => null, - champ pouvant être vide
	// 'on_main_page' => 1,		// 'on_main_page' => 1,
	// 'pos' => 1, - ~~field~~ position		// 'pos' => 1, - position du champ
	// 'value' => null		// 'value' => null
	// )), ...)</nowiki>		// )), ...)</nowiki>
	<br><br><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 "L'étape suivante pour un client consiste à choisir une date et une heure pour son service. Nous avons utilisé un sélecteur de date Bootstrap dans l'exemple d'utilisation de l'API, mais vous pouvez également utiliser celui-ci ou tout autre calendrier. Pour définir la première date de votre calendrier, utilisez la méthode getFirstWorkingDay. Elle peut prendre l'identifiant de l'employé comme paramètre et renvoie la prochaine date à laquelle l'employé sélection..."

2025-05-15T12:23:14Z

Created page with "L'étape suivante pour un client consiste à choisir une date et une heure pour son service. Nous avons utilisé un sélecteur de date Bootstrap dans l'exemple d'utilisation de l'API, mais vous pouvez également utiliser celui-ci ou tout autre calendrier. Pour définir la première date de votre calendrier, utilisez la méthode getFirstWorkingDay. Elle peut prendre l'identifiant de l'employé comme paramètre et renvoie la prochaine date à laquelle l'employé sélection..."

← Older revision		Revision as of 12:23, 15 May 2025
Line 210:		Line 210:
	$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">

User API guide/fr - Revision history

Admin at 19:47, 16 February 2026

FuzzyBot: Updating to match new version of source page

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); } } "

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); } }

"