Bli partner

API-dokumentasjon

Get api token

Using Simplybook API methods require an authentification. 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 'Plugins' link and select API plugin 'Settings'.

var token = loginClient.getToken(companyLogin, apiKey);

Selskapspålogging

Api-nøkkel

Kodeeksempel:

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

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

Get event list

You have just received auth token. Now you need to create JSON RPC Client, set http headers and then use this client to get data from Simplybook server. To get services list use getEventList() function as it is shown in code example below.

var events = client.getEventList();

Kodeeksempel:

var client = new JSONRpcClient({
	'url': 'https://user-api.simplybook.me',
	'headers': {
		'X-Company-Login': '{companyLogin}',
		'X-Token': '{token}'
	},
	'onerror': function (error) {
		alert(error);
	}
});
var services = client.getEventList();

var client = new JSONRpcClient({
	'url': 'https://user-api.simplybook.me',
	'headers': {
		'X-Company-Login': '{companyLogin}',
		'X-Token': '{token}'
	},
	'onerror': function (error) {
		alert(error);
	}
});
var services = client.getEventList();

Get performer list

Also you need to get list of all service performers. For this purpose use getUnitList() function.

var units = client.getUnitList();

Kodeeksempel:

var performers = client.getUnitList();

var performers = client.getUnitList();

Filter performers by service

Now let users select service and then performer. Please note that services can be attached to certain performer or can be provided by any performer from list. That is why you should filter performers before users make selection, use unit_map param in service object for this. See code example below.

Kodeeksempel:

// fetch service and performers selects here
var serviceId;
var performerId;
jQuery('#select_event_id').empty();
jQuery('#select_unit_id').empty();
jQuery('#select_event_id').append('<option value=""></option>');
jQuery('#select_unit_id').append('<option value=""></option>');
for (var id in services) {
    jQuery('#select_event_id').append('<option value="' + id + '">' + services[id].name + '</option>');
}
for (var id in performers) {
    jQuery('#select_unit_id').append('<option value="' + id + '">' + performers[id].name + '</option>');
}
jQuery('#select_event_id').change(function () {
	// service id
	serviceId = jQuery(this).val();
	var selectedService = services[serviceId];
	// filter available performers
	if (selectedService) {
		if (typeof(selectedService.unit_map) != 'undefined' && selectedService.unit_map.length) {
			jQuery('#select_unit_id option').attr('disabled', true);
			jQuery('#select_unit_id option[value=""]').attr('disabled', false);
			for (var i = 0; i < selectedService.unit_map.length; i++) {
				jQuery('#select_unit_id option[value="' + selectedService.unit_map[i] + '"]').attr('disabled', false);
			}
		} else {
			jQuery('#select_unit_id option').attr('disabled', false);
		}
	}
	jQuery('#eventId').val(serviceId).change();
});
jQuery('#select_unit_id').change(function () {
	performerId = jQuery(this).val();
});

// fetch service and performers selects here
var serviceId;
var performerId;
jQuery('#select_event_id').empty();
jQuery('#select_unit_id').empty();
jQuery('#select_event_id').append('<option value=""></option>');
jQuery('#select_unit_id').append('<option value=""></option>');
for (var id in services) {
    jQuery('#select_event_id').append('<option value="' + id + '">' + services[id].name + '</option>');
}
for (var id in performers) {
    jQuery('#select_unit_id').append('<option value="' + id + '">' + performers[id].name + '</option>');
}
jQuery('#select_event_id').change(function () {
	// service id
	serviceId = jQuery(this).val();
	var selectedService = services[serviceId];
	// filter available performers
	if (selectedService) {
		if (typeof(selectedService.unit_map) != 'undefined' && selectedService.unit_map.length) {
			jQuery('#select_unit_id option').attr('disabled', true);
			jQuery('#select_unit_id option[value=""]').attr('disabled', false);
			for (var i = 0; i < selectedService.unit_map.length; i++) {
				jQuery('#select_unit_id option[value="' + selectedService.unit_map[i] + '"]').attr('disabled', false);
			}
		} else {
			jQuery('#select_unit_id option').attr('disabled', false);
		}
	}
	jQuery('#eventId').val(serviceId).change();
});
jQuery('#select_unit_id').change(function () {
	performerId = jQuery(this).val();
});

Get closest day with available time slots

After user has selected service and perfomer you should get first working day for the selected performer and set it as datepicker active date. Use getFirstWorkingDay() function for this purpose.

var firstWorkingDay = client.getFirstWorkingDay(performerId);

Velg tjeneste

Velg utøver

Kodeeksempel:

var firstWorkingDay = client.getFirstWorkingDay(performerId);

var firstWorkingDay = client.getFirstWorkingDay(performerId);

Disable not working time in calendar

Becides setting active date in your datepicker you also can disable dayoffs in it using data of work calendar. See how the getWorkCalendar() function works in code example.

workCalendar = client.getWorkCalendar(year, month, performerId);

Kodeeksempel:

// Init datepicker.
var workCalendar = {};
jQuery('#datepicker').datepicker({
	'onChangeMonthYear': function (year, month, inst) {
		workCalendar = client.getWorkCalendar(year, month, performerId);
		jQuery('#datepicker').datepicker('refresh');
	},
	'beforeShowDay': function (date) {
		var year = date.getFullYear();
		var month = ("0" + (date.getMonth() + 1)).slice(-2);
		var day = ("0" + date.getDate()).slice(-2);
		var date = year + '-' + month + '-' + day;
		if (typeof(workCalendar[date]) != 'undefined') {
			if (parseInt(workCalendar[date].is_day_off) == 1) {
				return [false, "", ""];
			}
		}
		return [true, "", ""];
	}
});
var firstWorkingDateArr = firstWorkingDay.split('-');
workCalendar = client.getWorkCalendar(firstWorkingDateArr[0], firstWorkingDateArr[1], performerId);

jQuery('#datepicker').datepicker('refresh');

// Init datepicker.
var workCalendar = {};
jQuery('#datepicker').datepicker({
	'onChangeMonthYear': function (year, month, inst) {
		workCalendar = client.getWorkCalendar(year, month, performerId);
		jQuery('#datepicker').datepicker('refresh');
	},
	'beforeShowDay': function (date) {
		var year = date.getFullYear();
		var month = ("0" + (date.getMonth() + 1)).slice(-2);
		var day = ("0" + date.getDate()).slice(-2);
		var date = year + '-' + month + '-' + day;
		if (typeof(workCalendar[date]) != 'undefined') {
			if (parseInt(workCalendar[date].is_day_off) == 1) {
				return [false, "", ""];
			}
		}
		return [true, "", ""];
	}
});
var firstWorkingDateArr = firstWorkingDay.split('-');
workCalendar = client.getWorkCalendar(firstWorkingDateArr[0], firstWorkingDateArr[1], performerId);

jQuery('#datepicker').datepicker('refresh');

Get available time slots

When user has selected a date you can load time intervals when service is available to be booked. Use the getStartTimeMatrix() function to get list of start time of time slots.

var startMatrix = client.getStartTimeMatrix(from, to, eventId, unitId, count)

Kodeeksempel:

// Handle date selection
var count = 1; // How many slots book
function formatDate(date) {
	var year = date.getFullYear();
	var month = ("0" + (date.getMonth() + 1)).slice(-2);
	var day = ("0" + date.getDate()).slice(-2);
	
	return year + '-' + month + '-' + day;
}

function drawMatrix(matrix) {
	jQuery('#starttime').empty();
	
	for (var i = 0; i < matrix.length; i++) {
		jQuery('#starttime').append('<span data-time="' + matrix[i] + '">' + matrix[i] + '</span>');
	}
	jQuery('#starttime span').click(function () {
		startTime = jQuery(this).data('time');
		
		jQuery('#starttime span').removeClass('selected');
		jQuery(this).addClass('selected');
	});
}

jQuery('#datepicker').datepicker('option', 'onSelect', function () {
	var startDate = formatDate(jQuery(this).datepicker('getDate'));
	jQuery('#dateFrom, #dateTo').val(startDate);
	
	var startMatrix = client.getStartTimeMatrix(startDate, startDate, serviceId, performerId, count);
	
	drawMatrix(startMatrix[startDate]);
});
var startMatrix = client.getStartTimeMatrix(firstWorkingDay, firstWorkingDay, serviceId, performerId, count);
drawMatrix(startMatrix[firstWorkingDay]);

// Handle date selection
var count = 1; // How many slots book
function formatDate(date) {
	var year = date.getFullYear();
	var month = ("0" + (date.getMonth() + 1)).slice(-2);
	var day = ("0" + date.getDate()).slice(-2);
	
	return year + '-' + month + '-' + day;
}

function drawMatrix(matrix) {
	jQuery('#starttime').empty();
	
	for (var i = 0; i < matrix.length; i++) {
		jQuery('#starttime').append('<span data-time="' + matrix[i] + '">' + matrix[i] + '</span>');
	}
	jQuery('#starttime span').click(function () {
		startTime = jQuery(this).data('time');
		
		jQuery('#starttime span').removeClass('selected');
		jQuery(this).addClass('selected');
	});
}

jQuery('#datepicker').datepicker('option', 'onSelect', function () {
	var startDate = formatDate(jQuery(this).datepicker('getDate'));
	jQuery('#dateFrom, #dateTo').val(startDate);
	
	var startMatrix = client.getStartTimeMatrix(startDate, startDate, serviceId, performerId, count);
	
	drawMatrix(startMatrix[startDate]);
});
var startMatrix = client.getStartTimeMatrix(firstWorkingDay, firstWorkingDay, serviceId, performerId, count);
drawMatrix(startMatrix[firstWorkingDay]);

Check if additional fields plugin is activated

Now check if additional fields plugin is active to define what should be shown to client in the next step. See isPluginActivated() function usage example.

var additionalFieldsActivated = client.isPluginActivated('event_field');

Kodeeksempel:

var additionalFieldsActivated = client.isPluginActivated('event_field');

var additionalFieldsActivated = client.isPluginActivated('event_field');

Get additional fields

If addtional fields plugin is active, you should load additional field list using getAdditionalFields() function and add them to client details form.

Kodeeksempel:

// load additional fields
var additionalFields = [];

function clearAdditionalFields() {
	jQuery('#additional-fields').empty();
	additionalFields = [];
}

function addAdditionalField(field) {
	var container = jQuery('<div class="form-group"></div>');
	var title = jQuery('<div class="control-label">' + field.title + '</div>');
			
	container.append(title);
			
	var fieldContainer = jQuery('<div class="field"></div>');
			
	container.append(fieldContainer);
			
	var fieldNode = null;
	switch (field.type) {
		case 'checkbox':
			fieldNode = jQuery('<input type="checkbox" name="' + field.name + '" id="' + field.name + '" value="1" />');
			if (field['default']) {
				fieldNode.attr('checked', true);
			}
			break;
		case 'select':
			fieldNode = jQuery('<select class="select select2" name="' + field.name + '" id="' + field.name + '"></select>');
			var values = field.values.split(',');
			for (var k = 0; k < values.length; k++) {
				fieldNode.append(jQuery('<option value="' + values[k].trim() + '">' + values[k].trim() + '</option>'));
			}
			if (field['default']) {
				fieldNode.val(field['default']);
			}
			break;
		case 'textarea':
			fieldNode = jQuery('<textarea name="' + field.name + '" id="' + field.name + '"></textarea>');
			if (field['default']) {
				fieldNode.val(field['default']);
			}
			break;
		default:
			fieldNode = jQuery('<input type="text" name="' + field.name + '" id="' + field.name + '" />');
			if (field['default']) {
				fieldNode.val(field['default']);
			}
			break;
	}
	if (fieldNode) {
		if (field.type == 'checkbox') {
			fieldNode.addClass('checkbox');
		} else {
			fieldNode.addClass('form-control');
		}
		fieldContainer.append(fieldNode);
		jQuery('#additional-fields').append(container);
	}
}

if (additionalFieldsActivated) {
	clearAdditionalFields();
	additionalFields = client.getAdditionalFields(serviceId);
	for (var i = 0; i < additionalFields.length; i++) {
		addAdditionalField(additionalFields[i]);
	}
}

// load additional fields
var additionalFields = [];

function clearAdditionalFields() {
	jQuery('#additional-fields').empty();
	additionalFields = [];
}

function addAdditionalField(field) {
	var container = jQuery('<div class="form-group"></div>');
	var title = jQuery('<div class="control-label">' + field.title + '</div>');
			
	container.append(title);
			
	var fieldContainer = jQuery('<div class="field"></div>');
			
	container.append(fieldContainer);
			
	var fieldNode = null;
	switch (field.type) {
		case 'checkbox':
			fieldNode = jQuery('<input type="checkbox" name="' + field.name + '" id="' + field.name + '" value="1" />');
			if (field['default']) {
				fieldNode.attr('checked', true);
			}
			break;
		case 'select':
			fieldNode = jQuery('<select class="select select2" name="' + field.name + '" id="' + field.name + '"></select>');
			var values = field.values.split(',');
			for (var k = 0; k < values.length; k++) {
				fieldNode.append(jQuery('<option value="' + values[k].trim() + '">' + values[k].trim() + '</option>'));
			}
			if (field['default']) {
				fieldNode.val(field['default']);
			}
			break;
		case 'textarea':
			fieldNode = jQuery('<textarea name="' + field.name + '" id="' + field.name + '"></textarea>');
			if (field['default']) {
				fieldNode.val(field['default']);
			}
			break;
		default:
			fieldNode = jQuery('<input type="text" name="' + field.name + '" id="' + field.name + '" />');
			if (field['default']) {
				fieldNode.val(field['default']);
			}
			break;
	}
	if (fieldNode) {
		if (field.type == 'checkbox') {
			fieldNode.addClass('checkbox');
		} else {
			fieldNode.addClass('form-control');
		}
		fieldContainer.append(fieldNode);
		jQuery('#additional-fields').append(container);
	}
}

if (additionalFieldsActivated) {
	clearAdditionalFields();
	additionalFields = client.getAdditionalFields(serviceId);
	for (var i = 0; i < additionalFields.length; i++) {
		addAdditionalField(additionalFields[i]);
	}
}

Perform booking

After client has filled his information into additional fields you should start booking process by calling book() method.

Kundens navn

Kundens e-post

Telefon til kunden

Kodeeksempel:

// Collect client data
var clientData = {
	'name': jQuery('#clientName').val(),
	'email': jQuery('#clientEmail').val(),
	'phone': jQuery('#clientPhone').val()
};
// Collect additional fields
var additionalFieldValues = {};
jQuery('#additional-fields input, #additional-fields select, #additional-fields textarea').each(function () {
	var val = '';
	if (jQuery(this).attr('type') == 'checkbox') {
		if (jQuery(this).is(':checked')) {
			val = 1;
		} else {
			val = 0;
		}
	} else {
		val = jQuery(this).val();
	}
	additionalFieldValues[jQuery(this).attr('name')] = val;
});
var count = 1;

var result = client.book(serviceId, performerId, startDate, startTime, clientData, additionalFieldValues, count);

// Collect client data
var clientData = {
	'name': jQuery('#clientName').val(),
	'email': jQuery('#clientEmail').val(),
	'phone': jQuery('#clientPhone').val()
};
// Collect additional fields
var additionalFieldValues = {};
jQuery('#additional-fields input, #additional-fields select, #additional-fields textarea').each(function () {
	var val = '';
	if (jQuery(this).attr('type') == 'checkbox') {
		if (jQuery(this).is(':checked')) {
			val = 1;
		} else {
			val = 0;
		}
	} else {
		val = jQuery(this).val();
	}
	additionalFieldValues[jQuery(this).attr('name')] = val;
});
var count = 1;

var result = client.book(serviceId, performerId, startDate, startTime, clientData, additionalFieldValues, count);

Summary

It was simple example how you can use Simplybook API. Check out all available API methods here. Feel free to contact us and ask any questions.

Thank you for reading!

Bruk vårt API for utviklere til å lage ditt eget bestillingsgrensesnitt. Du kan designe hvilken som helst løsning du ønsker, fra den enkleste widgeten til en multifunksjonell applikasjon med funksjonalitet som er tilpasset i henhold til bedriftens spesifikke behov.

Simplybook Application Programming Interface bruker JSON-RPC 2.0-protokollen.

Se et eksempel på et API-basert bestillingsgrensesnitt, og les også kildekoden til denne løsningen.

Autorisasjon

Simplybook API-metoder krever en autentisering. For å autorisere i Simplybook API må du få en tilgangsnøkkel - tilgangstoken. For å få denne tilgangsnøkkelen bør du ringe JSON-RPC-metoden getToken på http://user-api.simplybook.me/login-tjenesten ved å sende din personlige API-nøkkel. Du kan kopiere API-nøkkelen din i administrasjonsgrensesnittet: gå til lenken 'Plugins' og velg API-plugin 'Innstillinger'. Deretter må du starte ekstern tilgang til Simplybook API. Forespørselen din skal inneholde følgende overskrifter: 'X-Company-Login', 'X-Token'.

Å få tilgangskoden kan implementeres enten fra klientsiden eller fra serveren din, som er den sikreste løsningen.

Du kan bruke javascript JSON-RPC-klientbiblioteket og php JSON-RPC-klientbiblioteket fra våre eksempler for din egen løsningsutvikling.

Client API (Company public service) autorisasjon

Autorisasjon fra kode på klientsiden

Hente token-nøkkelen.


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

Initialisering JSON-RPC-klient


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

Autorisasjon fra kode på serversiden

Hente token-nøkkelen.


    $loginClient = new JsonRpcClient('https://user-api.simplybook.me' . '/login/');
    $token = $loginClient->getToken(YOUR_COMPANY_LOGIN, YOUR_API_KEY);

Initialisering JSON-RPC-klient.


    $client = new JsonRpcClient( 'https://user-api.simplybook.me' . '/', array(
        'headers' => array(
            'X-Company-Login: ' .  YOUR_COMPANY_LOGIN,
            'X-Token: ' . $token
        )
    ));

Autorisation API Utilisateur/Admin (bedriftsadministrasjonstjeneste)

Autorisasjon fra kode på klientsiden

Hente token-nøkkelen.


    var loginClient = new JSONRpcClient({
        'url': {$api_url} + '/login',
        'onerror': function (error) {},
    });
    var token = loginClient.getUserToken( YOUR_COMPANY_LOGIN,  YOUR_USER_LOGIN,  YOUR_USER_PASSWORD);

Initialisering JSON-RPC-klient.


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

Autorisasjon fra kode på serversiden

Hente token-nøkkelen.


    $loginClient = new JsonRpcClient('https://user-api.simplybook.me' . '/login/');
    $token = $loginClient->getUserToken({YOUR_COMPANY_LOGIN, YOUR_USER_LOGIN, YOUR_USER_PASSWORD);

Initialisering JSON-RPC-klient.


    $client = new JsonRpcClient('https://user-api.simplybook.me' . '/admin/', array(
        'headers' => array(
            'X-Company-Login: ' . YOUR_COMPANY_LOGIN,
            'X-User-Token: ' . $token
        )
    ));

Hente data fra Simplybook-serveren

En bestillingsside er vanligvis en side der klienter velger tjenesten de trenger, en ansatt og et tidspunkt for møtet. Deretter legger kunden inn litt kontaktinformasjon og bekrefter bookingen. De mer komplekse løsningene kan omfatte utfylling av forskjellige tilleggsfelt, bestilling av en gruppe eller flere ganger og så videre. La oss beskrive arbeidsflyten for å opprette den enkleste bestillingssiden. Hvis du trenger å legge til litt ekstra funksjonalitet på siden din, kan du se her den komplette listen over Simplybook API-metoder.

Det første du bør vise, er altså listen over tjenester og listen over ansatte. Hent disse dataene ved hjelp av metodene getEventList og getUnitList. Begge returnerer en liste med fullstendig informasjon om hvert element i den, så du har mange muligheter for å vise tjenester og ansatte på siden din. For å filtrere ansatte bruker du egenskapen unit_map i tjenestelisten, den inneholder informasjon om ansatte som kan levere den valgte tjenesten.

Kodeeksempel for å hente tjenesteliste


    $services = $client->getEventList();
    // returns array(array(
    //     'id' => 1, - service id
    //     'name' => 'Service 1', - service's name
    //     'description' => 'Describe your service...', - service description
    //     'duration' => 60, - service duration
    //     'hide_duration' => 0, - Hide duration to clients flag,
    //     'picture' => null, - file name of picture or null
    //     'picture_path' => '/uploads/apidemo/event__picture/small/', - full path to picture,
    //     'position' => 1 - service position
    //     'is_active' => 1, - the service is activated
    //     'is_public' => 1, - the service is allowed to book by clients
    // ), ...)

Kodeeksempel for innhenting av liste over tjenesteytere


    $services = $client->getUnitList();
    // returns array(array(
    //    'id' => 1, - performer id
    //    'name' => 'Provider 1', - performer name
    //    'phone' => '111111111', - perfomer phone number
    //    'description' => 'Describe your performer...', - performer description
    //    'email' => '[email protected]', - perfomer email,
    //    'is_active' => 1, - the performer is activated
    //    'is_visible' => 1, - the perfomer is visible for clients,
    //    'picture' => null, - file name of picture or null,
    //    'picure_path' => '/uploads/apidemo/unit_group__picture/small/', - full path to picture
    //    'position' => 1, - performer position
    //    'qty' => 1, performer quantity
    // ), ...)

Det neste trinnet for en klient er å velge dato og klokkeslett for tjenesten. Vi har brukt en Bootstrap-datovelger i API-brukseksempelet, du kan også bruke denne eller en hvilken som helst annen kalender. For å angi kalenderens første dato bruker du metoden getFirstWorkingDay. Den kan ta ansatt-ID som parameter og returnerer den neste datoen da den valgte ansatte (eller alle ansatte i bedriften som standard) er tilgjengelig for booking.{""|t} For å vise tidsluker innenfor en valgt dato trenger du metodene getWorkCalendar og getStartTimeMatrix. Den første metoden gir deg informasjon om arbeidsdagens start- og sluttidspunkt, og om fridager. Den andre metoden returnerer en liste over tidsluker som kan bookes for en bestemt dato.

Kodeeksempel for innhenting av informasjon om arbeidsdager


    $year = 2020;
    $month = 3; // March
    $performerId = 1; // Can be null
    $workDaysInfo = $client->getWorkCalendar($year, $month, $performerId);
    // returns array(
    //     '2020-03-01' => array('from' => '09:00:00', 'to' => '18:00:00', 'is_day_off' => 0),
    //     '2020-03-02' => array('from' => '09:00:00', 'to' => '18:00:00', 'is_day_off' => 0),
    //     ...
    //);

Kodeeksempel for å hente starttidsmatrise


    $dateFrom = '2020-03-03';
    $dateTo = '2020-03-04';
    $serviceId = 1;
    $performerId = 1;
    $qty = 1;
    $availableTime = $client->getStartTimeMatrix($dateFrom, $dateTo, $serviceId, $performerId, $qty);
    // returns array(
    //     '2015-03-03' => array('09:00:00', '09:30:00', '10:00:00', ....),
    //     '2015-03-04' => array('09:00:00', '09:30:00', '10:00:00', ....),
    //);

En annen nyttig metode du kanskje trenger, er calculateEndTime. Hver tjeneste kan ha sin egen varighet, og bedriftens ansatte kan også ha forskjellige arbeidsplaner fra dag til dag. Så ved å bruke denne metoden kan du vise en klient en sluttdato og et klokkeslett for tjenesten han har bestilt på en korrekt måte.

Kodeeksempel for beregning av bookingens sluttidspunkt


    $startDateTime = '2020-03-03 09:00:00';
    $serviceId = 1;
    $performerId = 1;
    $availableTime = $client->calculateEndTime($startDateTime, $serviceId, $performerId);
    // returns '2020-03-03 10:00:00'

Når en kunde klikker på knappen Bekreft bestillingen, må du kalle metoden Book. Dette er hovedfunksjonen som utfører alle nødvendige valideringer og registrerer en ny bestilling i Simplybook-systemet. Den tar informasjon om bestillingen, klientdata som navn og telefon og noen ekstra parametere. Se alle parameterbeskrivelser for denne metoden i listen over API-funksjoner. Bestillingsmetodens svar inneholder en unik kode og andre detaljer om den nye bestillingen eller listen over feil hvis noen problemer oppstod, slik at du kan bruke denne informasjonen til å vise bestillingsresultatet til en klient på en overbevisende og intuitiv måte

Bruk av hemmelig API-nøkkel

I noen tilfeller kan bestillingsmetoden kreve bekreftelse, f.eks. hvis du godtar betalinger fra kunder, bekrefter du bestillingen først etter at betalingen allerede er kommet. Simplybook API confirmBookng-metoden tar booking-id og sikker signatur som parametere (en annen metode som krever sikker signatur er cancelBookng). For sikker signaturgenerering bør din hemmelige API-nøkkel brukes. Se hvordan det kan gjøres i eksempelet nedenfor. Du finner den hemmelige nøkkelen i administrasjonsgrensesnittet under lenken 'Innstillinger' for API-plugin i listen 'Plugins'.

Kodeeksempel på bestilling av tjeneste og bekreftelse av denne ved hjelp av hemmelig API-nøkkel


    $additionalFields = array(
	'6740d3bce747107ddb9a789cbb78abf3' => 'value1',
	'b0657bafaec7a2c9800b923f959f8163' => 'value2'
    );

    $clientData = array(
        'name' => 'Client name',
        'email' => '[email protected]',
        'phone' => '+13152108338'
    );

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

    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 '<br>Confirm result</b><br />';
           var_dump($result);
        }
    }

Kodeeksempel for innhenting av tilleggsfelt


    $fields = $client->getAdditionalFields($eventId);
    // returns - array(array(
    //		'name' => 'b0657bafaec7a2c9800b923f959f8163', - field name
    //		'title' => 'Test digits', - field title
    //		'type' => 'digits', - field type
    //		'values' => null, - available values for select field type
    //		'default' => null, - default value for field
    //		'is_null' => null, - is filed nullable
    //		'on_main_page' => 1,
    //		'pos' => 1, - field position
    //		'value' => null
    // )), ...)

Plugins for Simplybook

Hvis bedriften din har behov for ekstra funksjonalitet, kan du aktivere noen av våre tilleggsprogrammer. Den komplette listen over programtillegg med detaljert beskrivelse er tilgjengelig i administrasjonsgrensesnittet under lenken "Programtillegg". Etter at den nødvendige programtillegget er aktivert, vil de tilsvarende API-metodene aktiveres slik at du kan bruke dem i koden din.

Kodeflyt for bestillingsfunksjonalitet

Autoriser i Simplybook API med funksjonen loginClient. getToken(companyLogin, apiKey); function.

Sjekk om plugin-modulen Tjenestekategorier er aktivert av isPluginActivated('event_category') hvis ja, vis da listen over kategorier getCategoriesList().

Hent en liste over tjenester (hendelser) og utøvere (enheter) ved hjelp av funksjonene getEventList( ) og getUnitList( ). Hvis matrisen 'unit_map' er tilgjengelig for en tjeneste, betyr det at denne tjenesten kun kan leveres av gitte utøvere.

Hvis Any Employee selector-plugin er aktivert isPluginActivated('any_unit' ) og ingen spesiell varighet er angitt for tjeneste-utøver-paret i 'unit_map'-matrisen, bør brukeren ha lov til å velge Any provider -alternativet eller velge leverandør manuelt. Men manuelt valg av utøvere skal ikke være mulig hvis getCompanyParam('any_unit__hide_other_units') er aktivert.

Bruk getStartTimeMatrix ($from som gjeldende dato, $to som gjeldende dato, $eventId, $unitId, $count som valgt deltakerverdi ) for å få tilgjengelige tidsluker for en gitt dato. $unitId skal være null hvis alternativet Alle ansatte er valgt.

Hvis Alle ansatte-velgeren er aktiv og Alle ansatte ble valgt, kaller du getAvailableUnits($eventId, $dateTime, $count) for å få tilgjengelige $unitId

Hvis plugin-modulen for tilleggsfelt er aktivert isPluginActivated('event_field' ), anrop funksjonen getAdditionalFields ($eventId ) for å få en liste over felt som klienten skal fylle ut.

Ring book($eventId, $unitId, $date, $time, $clientData, $additional, $count, $batchId) for å foreta en bestilling.

Tjenestens URL https://user-api.simplybook.me/login

getServiceUrl ($companyLogin)

Returns API url for given company login
- @param String $companyLogin
- @return String
getToken ($companyLogin, $apiKey)

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]].
- @param String $companyLogin
- @param String $apiKey
- @return String
getUserToken ($companyLogin, $userLogin, $userPassword)

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]].

You can use either user password or API User Key for $userPassword parameter:
- Traditional password authentication (requires 2FA if enabled)
- API User Key (starts with "api_user_key_...") - bypasses IP verification

API User Keys can be generated in Settings > API User Keys section.
Example: var token = loginClient.getUserToken(YOUR_COMPANY_LOGIN, YOUR_USER_LOGIN, "api_user_key_...");
- @param String $companyLogin a company identifier (login)
- @param String $userLogin user's login associated with company
- @param String $userPassword user's password or API User Key (starts with "api_user_key_...")
- @return String
getApplicationToken ($applicationApiKey)

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.
- @param String $applicationApiKey
- @return String

Tjenestens URL https://user-api.simplybook.me/

getUnitList ($isVisibleOnly, $asArray, $handleClasses, $searchString)

{@inheritdoc}
- @param bool $isVisibleOnly
- @param bool $asArray
- @param integer $handleClasses
- @param string $searchString part of name (used for comboboxes)
- @return Array
getEventList ($isVisibleOnly, $asArray, $handleClasses, $searchString)

{@inheritdoc}
- @param bool $isVisibleOnly
- @param bool $asArray
- @param integer $handleClasses (1 - classes only, -1 without classes, null - skip classes check)
- @param string $searchString part of name (used for comboboxes)
- @return Array
getCategoriesList ($isPublic)

{@inheritdoc}
- @param bool $isPublic
- @return Array
getLocationsList ($isPublic)

{@inheritdoc}
- @param Boolean $isPublic
- @return Array
getPaymentProcessorConfig ($paymentProcessor)

Returns payment processor config
- @param String $paymentProcessor
- @return Array
validatePayment ($paymentInfo, $cartId)

Validate application payment.
- @param mixed $paymentInfo
- @param Integer $cartId
- @return Boolean
getBookingCart ($bookingIds)

Returns cart information by bookings ids.
cart_id and cart_hash is used to create secure signature to confirm cart payment.

status - current cart status
amount - is total amount to payment
currency - cart currency
cart - contains cart items. You can use them to provide information for payment system. Each item is object with following fields:
id - booking id
event_id - service id
name - event name + start date time (use it to provide cart information for payment system)
price - booking price
qty - qty of bookings
- @param Array $bookingIds
- @return Object
getBookingCartInfo ($cartId, $sign)

Returns current cart information
cart_id and cart_hash is used to create secure signature to confirm cart payment.

amount - is total amount to payment
currency - cart currency
cart - contains cart items. You can use them to provide information for payment system. Each item is object with following fields:
id - booking id
event_id - service id
name - event name + start date time (use it to provide cart information for payment system)
price - booking price
qty - qty of bookings
- @param Integer $cartId cart id
- @param String $sign signature. (md5($cartId . $cartHash . $secretKey))
- @return Object
getBookingCartStatus ($id)

Returns current cart status
Possible result values:

cancel - user has canceled payment
paid - user has paid
error - error has been occurred on validation payment
not_paid - cart is not paid yet or payment status is pending
- @param Integer $id
- @return String
confirmBookingCart ($cartId, $paymentProcessor, $sign)

Confirm booking cart. Use it to confirm payment. Signature is required.
- @param Integer $cartId cart id
- @param String $paymentProcessor payment processor name
- @param String $sign signature. (md5($cartId . $cartHash . $secretKey))
- @return Boolean
confirmBooking ($id, $sign)

Confirm booking. Signature is required.
$sign = md5($bookingId . $bookingHash . $secretKey);

Call this method from server side only
- @param Integer $id
- @param String $sign
- @return Boolean
confirmBookingPayment ($id, $paymentProcessor, $sign)

Confirm booking payment. Signature is required.
$sign = md5($bookingId . $bookingHash . $secretKey);

Call this method from server side only
- @param Integer $id
- @param String $paymentProcessor
- @param String $sign
- @return Boolean
confirmBookingBatch ($batchId, $batchType, $sign)

Confirms booking batch. Signature is required.
$sign = md5($batchId . $batchHash . $secret)

Call this method from server side only
- @param Integer $batchId
- @param String $batchType
- @param String $sign
- @return Boolean
getBooking ($id, $sign)

Returns an object with details information about booking. $sign parameter must be a string created
with formula: md5($bookingId . $bookingHash . $secretKey). You can get $bookingHash

value as result of [[#book|book]] API method call. Method return an error with code -32080
(Appointment couldn't be found) if record with specified id not exists. Methods returns an error with code -32085
(Signature error) if $sign parameter is wrong.
- @param Integer $id
- @param String $sign
- @return Object
getBookingDetails ($id, $sign)

Returns an object with details information about booking. $sign parameter must be a string created
with formula: md5($bookingId . $bookingHash . $secretKey). You can get $bookingHash

value as result of [[#book|book]] API method call. Method return an error with code -32080
(Appointment couldn't be found) if record with specified id not exists. Methods returns an error with code -32085
(Signature error) if $sign parameter is wrong.
- @param Integer $id
- @param String $sign
- @return Object
isPaymentRequired ($eventId)

Returns true if [[Plugins#Accept_payments|Accept payments]] plugin activated and event with specified id has
configured price. If no paramentes specified then method returns true if payments plugin activated and at least

one event has configured price. Otherwise returns false.
- @param Integer $eventId
- @return Boolean
book ($eventId, $unitId, $date, $time, $clientData, $additional, $count, $batchId, $recurringData)

Creates new booking record. Returns an object with appointment information or throw exception if booking time not
available or any of required parameters missed. If appointment requires confirmation, in result object will be

require_confirm = true. $startDate and $startTime specifies a date of
booking and time slot. Time value should be multiple to 'timeframe' configuration of company (see
[[#getTimeframe|getTimeframe]] API method). $endDate and $endTime parameters
should be calculated according to service duration. However you can specify different values to make appointment
longer or shorter then service configuration. Note that $endDate and $endTime should be
later in time than $startDate and $startTime. If your clients located in different time
zone you should specify 'client_time_offset' value in $clientData object as difference
between client's time zone and company's time zone in minutes. For example if company located in city with time
zone GMT+2 and customer located in city with GMT+3 then $clientTimeOffset will be 60 minutes. You
can get information about company's time zone using [[#getCompanyInfo|getCompanyInfo]] API method. To
create batch booking you can specify either count more then 1 or valid batchId (only one
parameter can be specified). You should specify an $additionalFields parameter if service requires
some additional fields (see [[Plugins#Additional fields|Additional fields plugin]]). To create a booking with promo code you
should pass it as additional field. For example: {"name": "promocode", "value": "some code", "type": "text"}

See [[#book response|example]] of book API method response.
- @see http://wiki.simplybook.me/index.php/Settings#Timeframe Timeframe information
- @param Integer $eventId
- @param Integer $unitId
- @param String $date in Y-m-d format
- @param String $time in H:i:s format
- @param Object|array $clientData eg. {name: 'Name', email: '[email protected]', phone: '+38099999999'}
- @param array|Object $additional additional params and fields. When the Anti Fraud captcha feature is enabled, pass <code>captcha_token</code> here (e.g. <code>{'captcha_token': '...'}</code>). Obtain a challenge via <code>getCaptchaChallenge()</code>, then generate the token using the ready-made JS widget (<code>/v2/js/lib/captcha/captcha-widget.js</code>). Full integration guide is in the Anti Fraud plugin settings.
- @param Integer $count bookings count, min. 1 (using for group bookings batch). (optional)
- @param Integer $batchId add booking to multiple bookings batch. (optional)
- @param Array $recurringData make booking recurrent. (optional)
- @return Object
getRecurringDatetimes ($eventId, $unitId, $date, $time, $recurringData, $productIds)

Get list of dates for recurring booking
- @param Integer $eventId
- @param Integer $unitId
- @param String $date
- @param String $time
- @param array $recurringData
- @param array $productIds
- @return array
hasUpcommingPromotions ()

Returns availability of active promotions
- @return Boolean
validatePromoCode ($code, $startDateTime, $eventId, $count, $clientData)

Validate promotion code.
Returns true in case promocode is valid otherwise throws exception with error.
- @param String $code
- @param String $startDateTime
- @param Integer $eventId
- @param Integer $count
- @param array|Object $clientData
- @return Boolean
getPromocodeInfo ($code)

Returns an object with detailed information about promotion by promotion code. Returns null if no promotions with
specified code were not found.
- @param String $code
- @return Array
getPromotionRewardInfo ($commonPromotionId, $clientId, $hash)

Returns promotion reward by common promotion id, client id and hash.
- @param Integer $commonPromotionId
- @param Integer $clientId
- @param String $hash
- @return Array
getUserLicenseText ()

Returns user license text if user license plugin is turned on,
otherwise throws exception
- @return String
getPrivacyPolicyText ()

Returns user privacy policy text if user license plugin is turned on and privacy policy is enabled,
otherwise throws exception
- @return String
getClientInfo ($clientId, $sign)

Returns client info by client id
- @param Integer $clientId
- @param String $sign signature = md5($clientId . $clientHash . $secretKey)
- @return Object
getClientInfoByLoginPassword ($login, $password)

Returns client information by clients login (email)/password
- @param String $login
- @param String $password
- @return Object
remindClientPassword ($email)

Sends remind email for client
- @param String $email
- @return Boolean
getClientByLoginHash ($hash, $setExpired, $expireOtherHashes)

Get client information by client login hash
- @param String $hash
- @param Boolean $setExpired
- @param Boolean $expireOtherHashes
- @return Object
modifyClientPassword ($clientId, $data, $sign)

Change client password
- @param int $clientId
- @param array $data
- @param string $sign
- @return bool
modifyClientInfo ($clientId, $data, $sign)

Edit client information data
- @param Integer $clientId
- @param Array $data
- @param String $sign signature = md5($clientId . $clientHash . $secretKey)
- @return Object
getMembershipList ()

Returns list of available memberships
- @return Array
getClientMembershipList ($filter, $clientId, $sign)

Returns purchased membership list
- @param Array $filter
- @param Integer $clientId
- @param String $sign
- @return Array
getClientBookings ($clientId, $sign, $filter)

Returns client bookings, accepts $filter ($filter {upcoming_only: true/false, confirmed_only: true/false})
- @param integer $clientId
- @param string $sign
- @param object|array $filter
- @return array
getProductList ($filter)

Returns product list with filter.
At this time filter can accept only service_id parameter
- @param object $filter
- @return array
getClassesList ($filter)

Returns company's classes list. Ordered by position
- @param Array $filter
- @return Array
getCaptchaChallenge ()

Returns captcha challenge data needed to render the SBCaptcha widget.
If captcha is disabled for the company, returns { provider: null }.

Pass the resulting object directly to `new SBCaptcha({ challenge: data, ... })`.
After the widget resolves, submit the token as `captcha_token` inside `$additional` when calling `book()`.

Response always includes:
widgetUrl — absolute URL of captcha-widget.js (the SBCaptcha universal loader)
assets — { js: [], css: [] } with all URLs already absolute
imageUrl — absolute URL (imagecaptcha only); relative path resolved against the company public domain
- @return array
rescheduleBook ($shedulerId, $sign, $startDate, $startTime, $endDate, $endTime, $additional, $clientTimeOffset, $clientTimezone)

Edit existing booking record. See [[#book|book]] API method description for more details about date/time parameters,
time zone handling and additional fields. Returns null if parameters not valid.
- @param int $shedulerId an id of booking to edit. See <code>[[#book|book]]</code> or <code>[[#getBookings|getBookings]]</code> API methods.
- @param string $sign
- @param String $startDate in Y-m-d format
- @param String $startTime in H:i:s format
- @param String $endDate in Y-m-d format
- @param String $endTime in H:i:s format
- @param array $additional
- @param int $clientTimeOffset
- @param string $clientTimezone
- @return Object
- @throws Api_Service_Exception
- @throws Exception
getCompanyParam ($key)

Returns company config value for key. A different set of keys available for public API and for company
administration API. Method return 'invalid params' error (code -32602) in case if access to specified key not

allowed. See [[#Company_params|list of available keys]].
- @param String $key
- @return mixed
getCompanyParams ($keys)

Returns company's config values for specified keys as key-value map. For non-existent and not-allowed param keys
it will return '''false''' as result. A different set of keys available for public API and for company

administration API. See [[#Company_params|list of available keys]].
- @param Array $keys
- @return Array
getCancellationPolicy ()

Returns cancellation policy rules.
If cancellation policy custom feature is not activated, method returns null.
- @return Array
getTimelineType ()

Returns company timeline type
- @return String
calculateEndTime ($startDateTime, $eventId, $unitId, $productIds)

Returns end datetime if booking is available, else return false
- @param String $startDateTime a date and time string in format 'Y-m-d H:i:s', eg. '2001-10-02 13:30:00'.
- @param Integer $eventId
- @param Integer $unitId
- @param array $productIds
- @return String
getWorkCalendar ($year, $month, $data)

Returns company work schedule as array
Eg.: {'2014-05-01': {'from': '09:00:00', 'to': '21:00:00', 'is_day_off': '0'}, '2014-05-02': ...}
- @param Integer $year
- @param Integer $month
- @param Integer|array $data pass unit_group_id as integer for old version or structure for new version like {unit_group_id: int, event_id: int}
- @return Object
getReservedTime ($from, $to, $eventId, $unitId, $count)

Returns map of objects for each day in specified date range. The key of the result mps is a date string. The value
is an array of two objects. Both objects contains list of time slots for type reserved_time and type

not_worked_time. reserved_time type represents time slots working time but already booked
by clients. Nobody knows what kind of data represented by not_worked_time type. Please don't use it.

If [[Plugins#Google calendar sync plugin|Google calendar sync plugin]] enabled then object with
reserved_time type will contain not empty list of time slots marked as busy in Google calendar. Call
[[#isPluginActivated|isPluginActivated('google_calendar_export')]] API method to check if Google
calendar sync plugin activated.

Example:
```
  {

    "2016-02-05": [

      {

        "dd": [], // time slots from Google calendar

        "events": [ // reserved time slots

          { "from": "16:00", "to": "16:30" },

          { "from": "16:30", "to": "17:00" },

          ... ],

        "type": "reserved_time",

      },

      {

        "events": [

          { "from": "09:00", "to": "09:30" },

          { "from": "09:30", "to": "10:00" },

          ... ],

        "type": "not_worked_time"

     }],

     ...

  }
```
- @param String $from
- @param String $to
- @param Integer $eventId
- @param Integer $unitId
- @param Integer $count
- @return Object
getWorkDaysInfo ($from, $to, $unitId, $eventId, $count, $productIds)

Returns an information about working hours and break times for specified service and performer for a period
between two dates. If only service specified then information about performer (or performers) will be taken from

service configuration. Method returns a list of objects for each date in specified period. Count of objects in
list depends on break times. For example if performer works from 9:00 till 19:00 with one hour break at 13:00 method
returns:
```
  {'2014-05-14' : [

    {'from': '09:00:00', 'to': '13:00:00'},

    {'from': '14:00:00', 'to': '19:00:00'}

  ] }
```
Warning! Method can return a time string '24:00:00' as right edge of time range. This happens in case if time
range finishes on midnight.
- @param String $from
- @param String $to
- @param Integer $unitId (optional)
- @param Integer $eventId (optional)
- @param Integer $count (optional)
- @param array $productIds (optional)
- @return array
getFirstWorkingDay ($data)

Returns first working date for unit
- @param Integer|array $data pass unit_group_id as integer for old version or structure for new version like {unit_group_id: int, event_id: int}
- @return String
getStartTimeMatrix ($from, $to, $eventId, $unitId, $count, $bookingId, $productIds)

Returns available start time, taking into account breaktimes, start and end working time
Eg.: {'2014-05-14': ['09:00:00', ...], ...}

If locations plugin activated for company you should pass a list as $unitID parameter for filter results with
units available only for selected location. See [[Plugins#Unit_location|Unit location]] plugin description for
more details.
- @param String $from
- @param String $to
- @param Integer $eventId
- @param Mixed $unitId can be Integer or Array of Integers
- @param Integer $count
- @param int $bookingId
- @param array $productIds
- @return array
getCartesianStartTimeMatrix ($from, $to, $eventId, $unitId, $count, $bookingId, $productIds)

Returns available start time, taking into account breaktimes, start and end working time.
The difference between getStartTimeMatrix and getCartesianStartTimeMatrix is that getCartesianStartTimeMatrix

provides time slots for each individual provider.
Eg.: {"provider_id": 1, "service_id": 1, "timeslots": {"2014-05-14": ['09:00:00', ...], ...}, ...}

If locations plugin activated for company you should pass a list as $unitID parameter for filter results with
units available only for selected location. See [[Plugins#Unit_location|Unit location]] plugin description for
more details.
- @param String $from
- @param String $to
- @param Integer $eventId
- @param Mixed $unitId can be Integer or Array of Integers
- @param Integer $count
- @param int $bookingId
- @param array $productIds
- @return array
getAvailableTimeIntervals ($dateFrom, $dateTo, $eventId, $unitId, $count)

Returns available time intervals for all service providers for given period, taking into account breaktimes, start and end working time
Eg.: {['2016-03-04': ['1': [['09:00:00','09:30:00'], ['11:15:00','14:45:00']] , ...], ...]}
- @param String $dateFrom
- @param String $dateTo
- @param Integer $eventId
- @param Mixed $unitId can be Integer or Array of Integers
- @param Integer $count
- @return Object
getServiceAvailableTimeIntervals ($dateFrom, $dateTo, $eventId, $unitId, $count)

Returns available time intervals for all servics for given period, taking into account breaktimes, start and end working time
Eg.: {['2016-03-04': ['1': [['09:00:00','09:30:00'], ['11:15:00','14:45:00']] , ...], ...]}
- @param String $dateFrom
- @param String $dateTo
- @param Mixed $eventId can be Integer or Array of Integers
- @param Integer $unitId
- @param Integer $count
- @return Object
getReservedTimeIntervals ($dateFrom, $dateTo, $eventId, $unitId, $count, $bookingId)

Returns not available time
Eg.: {'2014-05-14': [{'reserved_time': [{'from': '14:00', 'to': '16:30'}], 'type': "reserved_time"}, ...], ...}
- @param String $dateFrom
- @param String $dateTo
- @param Integer $eventId
- @param Integer|Array $unitId
- @param Integer $count
- @param int $bookingId
- @return array
getAvailableUnits ($eventId, $dateTime, $count, $unitId, $productIds)

Returns list of available unit ids for specified date and service or empty array if all units are not allowed.
Eg.: [1, 2, 3]
- @param Integer $eventId
- @param String $dateTime a date and time string in format 'Y-m-d H:i:s'
- @param int $count
- @param int $unitId
- @param array $productIds
- @return array
- @throws Exception
getAnyUnitData ()

Returns information about [[Plugins#Any_Employee_selector|Any Employee selector plugin]] configuration. Returns
null if plugin not enabled.

Example:
{
"description" : "Select this option, if you want to find an available time with any of the employees",
"hide_other_units" : 1, // 1 or 0
"image" : null,
"name" : "Any employee",
"picture_path" : null,
"random_selection" : 0 // 1 or 0
}
- @return Object
getAdditionalFields ($eventId)

Return additional fields for certain event if [[Plugins#Additional_fields|Additional fields plugin]] is
activated. Returns empty array otherwise. Call [[#isPluginActivated|isPluginActivated('event_field')]]

API method to check if 'event_field' plugin activated.
- @param Integer $eventId
- @return Array
getTimeframe ()

Returns company's timeframe configuration (in minutes). Timeframe can be either 5, 10, 15, 20, 30 or 60 minutes.
You can find more details about timeframe [[Settings#Timeframe|here]].
- @return Integer
isPluginActivated ($pluginName)

Return plugin status true if status active, else false. $pluginName parameter is a plugin identifier.
See [[Plugins|plugins]] page for full plugins description. See [[#Plugin's identifiers|list of available plugin's names]].
- @param String $pluginName
- @return Boolean
getPluginStatuses ($pluginNames)

Return plugin status true if status active, else false. See [[#Plugin's identifiers|list of available plugin's names]].
- @param Array $pluginNames
- @return Array
getCompanyInfo ()

Returns an object with detailed information about company. See [[#getCompanyInfo response|example of response]].
- @return Object
createBatch ()

Creates new booking batch record. Returns newly created batch id. You can use this id in [[#book|book]]
API method.
- @return Integer
getCountryPhoneCodes ()

Returns country phone code list
- @return Array
getPluginPromoInfoByCode ()

Returns an object with detailed information about promotion by promotion code. You can get promotion code
using [[Catalogue#getPromotionList|getPromotionList]] API method. If promotion record with specified

code not found then method returns an empty array (an empty object). If [[Plugins#Simply Smart Promotions|Simply Smart Promotions plugin]]
not enabled then method returns an error with code -32001 (Plugin is not activated). Use
[[#isPluginActivated|isPluginActivated('promo')]] API method call to check if plugin enabled.

See [[#getPromotionList response|example]] of getPromotionList API method response. Please note that
response contains a list of services for wich promotion discount can be applied (service_ids key).
- @param String
- @return Array
getCompanyTimezoneOffset ()

Returns company timezone offset and company timezone
- @return array

Tjenestens URL https://user-api.simplybook.me/admin

getUserPhoneValidationInfo ($userId, $number)

Get user db data (id, phone, is_validated)
- @param int $userId
- @param string $number
saveConfigKeys ($data, $module, $plugin)

Save configuration keys
- @param array $data
- @param string $module optional
- @param string $plugin optional
- @return array
getNotificationConfigStructure ($plugin)

Get structure of SMS and Email notification config params
- @param string $plugin optional
- @return mixed
getBookings ()

Returns list of bookings filtered by given params. Filter params represented as object with following fields:

* '''date_from''' a date of booking in string format 'Y-m-d'
* '''time_from''' a time string in format 'H:i:s'
* '''date_to''' a date string in format 'Y-m-d'
* '''time_to''' a time string in format 'H:i:s'
* '''created_date_from''' a date string in format 'Y-m-d'
* '''created_date_to''' a date string in format 'Y-m-d'
* '''edited_date_from''' a date string in format 'Y-m-d'
* '''edited_date_to''' a date string in format 'Y-m-d'
* '''unit_group_id''' an integer. Use it to get bookings assigned for certain service provider.
* '''event_id''' an integer. Use it to get bookings only for certain service.
* '''is_confirmed''' 1 or 0. If [[Plugins#Approve booking|Approve booking]] plugin enabled then method will return confirmed bookings with approve status 'new'.
* '''client_id''' an integer. Use it to get bookings only for certain client.
* '''order''' string either 'record_date', 'date_start' or 'date_start_asc'. By default used 'date_start' value.
* '''booking_type''' a string. Value of this field depends on Approve booking plugin status.
* '''code''' booking code
*: If plugin not active:
** '''all''' for all bookings (default value)
** '''cancelled''' alias to 'is_confirmed' equal to 0
** '''non_cancelled''' alias to 'is_confirmed' equal to 1
*: If plugin active:
** '''all''' for all bookings (default value)
** '''cancelled''' returns bookings with 'is_confirmed' field equals to 0 and approve booking status equals to 'cancelled' (or booking does not have any approve status)
** '''non_cancelled''' returns bookings with either 'is_confirmed' field equals to 1 or approve booking status equals to 'new'
** '''cancelled_by_client''' returns bookings approved by admin but cancelled by client
** '''cancelled_by_admin''' returns bookings cancelled by admin
** '''non_approved_yet''' returns bookings with approve status 'new'
** '''approved''' returns bookings with either 'is_confirmed' field equals to 1 and approve booking status equals to 'approved' (or booking does not have any approve status)

Example:
{
"date_from":"2015-12-29",
"date_to":"2015-12-29",
"booking_type":"cancelled",
"event_id":"5",
"order":"start_date"
}
- @param Array
- @return Array
pluginZapierSubscribe ($url, $notificationType)

'create', 'cancel', 'new_client', 'change', 'create_invoice', 'change_client', 'delete_client'
- @param string $url
- @param string $notificationType
- @return bool
getBookingDetailsZapierMock ()
- @return array
getClientInfo ($clientId)

Returns client data
- @param int|string $clientId
- @return array
getClientInfoZapier ($clientId)

Returns client data
- @param int|string $clientId
- @return array
- @throws \Exception
getClientInfoZapierMock ()

Returns client data
- @return array
- @throws \Exception
getBookingsZapier ()

Returns list of bookings filtered by given params
- @return Array
getInvoiceDetailsMock ()
- @return array
getBookingDetails ($id)

Returns detailed bookings object by booking id. See [[#getBookingDetails_response|response example]].
- @param integer $id booking id
- @return Array
getBookingOnlineMeetingLink ($id)

Get online meeting link for booking
- @param integer $id booking id
- @return string
getWorkDaysTimes ($startDateTime, $endDateTime, $type)

Return busy time by unit id by GoogleCalendar plugin if enabled.
Please note that this method may return not actual data because data synchronization between server and

Google Calendar may take some time and synchronized data are cached for 15 minutes.
- @param string $startDateTime
- @param string $endDateTime
- @param string $type either 'unit_group' or 'event'. Default value is 'unit_group'.
- @return array
getGoogleCalendarBusyTime ($startDateTime, $endDateTime, $unitId)

Returns a list of objects represented a time intervals marked as busy in Google Calendar. Each object of result
contains from and to properties with datetime string as value. This method only actual if

[Plugins#Google calendar sync plugin|Google calendar sync plugin] enabled. If plugin not enabled an empty list will
be returned. You should call [[#isPluginActivated|isPluginActivated('google_calendar_export')]] to
check status of the plugin. Each object of result contains from and to properties with
datetime string as value. Please note that this method may return not actual data because data synchronization
between server and Google Calendar may take some time and synchronized data are cached for 15 minutes.

Example:
[ {"from" : "2016-02-16 13:30:00", "to" : "2016-02-16 16:00:00"}, ... ]
- @param string $startDateTime a date and time string in format 'Y-m-d H:i:s'
- @param string $endDateTime a date and time string in format 'Y-m-d H:i:s'. You can date string avoiding time in this parameter. In this case method will use time value '23:59:59'.
- @param int $unitId
- @return Array
getGoogleCalendarBusyTimeAvailableUnits ()

Returns configured unit ids, allowed to sync busy time
- @return Array
getBookingLimitUnavailableTimeInterval ($startDateTime, $endDateTime, $eventId)

Returns time intervals not available for bookings because of configuration of [[Plugins#Limit bookings|Limit bookings]]
plugin for period of time. Returns empty array if plugin not available.
- @param string $startDateTime a date and time string in format 'Y-m-d H:i:s'
- @param string $endDateTime a date and time string in format 'Y-m-d H:i:s'
- @param int $eventId
- @return Array
getUnitWorkingDurations ($dateStart, $dateEnd, $unitGroupId)

Return working durations
- @param string $dateStart
- @param string $dateEnd
- @param int $unitGroupId
- @return Array
getWorkload ($dateStart, $dateEnd, $unitGroupId)

Return workload data for units in period of time. Workload for each unit represented as array with work hours
at index 0, confirmed booking hours as load at index 1 and cancelled bookings hours at index 2.

Example:
['2015-10-21' : {
5 : [
10, // working hours
10, // load hours (confirmed bookings hours)
0 // cancelled bookings hours
] }]
- @param string $dateStart
- @param string $dateEnd
- @param int $unitGroupId
- @return Array
getBookingRevenue ($dateStart, $dateEnd, $unitGroupId, $serviceId)

Return bookings count and revenue value for each date in specified period. Data grouped by unit id and
represented as array with bookings count at index 0 and revenue amount at index 1. You can filter data either

by unit or by service. Set $dateStart and $dateEnd to null to get data for current week.

Example:
['2015-11-12' : {
3 : [
11, // bookings count
128.53 // revenue
]}
- @param string $dateStart a date string in format 'Y-m-d'.
- @param string $dateEnd a date string in format 'Y-m-d'
- @param int $unitGroupId
- @param int $serviceId
- @return Array
getUnitWorkdayInfo ($dateStart, $dateEnd, $unitGroupId)

Return workday info (date_start and date_end)
- @param string $dateStart
- @param string $dateEnd
- @param int $unitGroupId
- @return array
cancelBooking ($id)

Cancels booking. Returns true on success. Returns an error with code -32080 (Appointment couldn't be found) if
no booking with specified id were found.
- @param Integer $id
- @return Boolean
cancelBatch ($id, $bookingIds)

Cancel batch of bookings. Returns true on success. Returns an error with code -32080 (Appointment couldn't be found)
if no booking with specified id were found. A booking with first id in $bookingIds list is used for

information in notifications.
- @param Integer $id identifier of batch. See <code>[[#createBatch|createBatch]]</code> API method.
- @param Array $bookingIds ids of bookings included to batch.
- @return bool
book ($eventId, $unitId, $clientId, $startDate, $startTime, $endDate, $endTime, $clientTimeOffset, $additional, $count, $batchId, $recurringData)

Creates new booking record. Returns an object with appointment information or throw exception if booking time not
available or any of required parameters missed. If appointment requires confirmation, in result object will be

require_confirm = true. $startDate and $startTime specifies a date of
booking and time slot. Time value should be multiple to 'timeframe' configuration of company (see
[[#getTimeframe|getTimeframe]] API method). $endDate and $endTime parameters
should be calculated according to service duration. However you can specify different values to make appointment
longer or shorter then service configuration. Note that $endDate and $endTime should be
later in time than $startDate and $startTime. If your clients located in different time
zone you should specify 'client_time_offset' value in $clientData object as difference
between client's time zone and company's time zone in minutes. For example if company located in city with time
zone GMT+2 and customer located in city with GMT+3 then $clientTimeOffset will be 60 minutes.
You can get information about company's
time zone using [[#getCompanyInfo|getCompanyInfo]] API method. To create batch booking you can
specify either count more then 1 or valid batchId (only one parameter can be
specified). You should specify an $additionalFields parameter if service requires some additional
fields (see [[Plugins#Additional fields|Additional fields plugin]]).

To create a booking with promo code you should pass it as additional field. For example: {"promocode": "some code"}

If [[Plugins#Unit location|Unit location]] enabled you need to pass locations ID parameter as additional field
location_id. For example: {"location_id": "1"}. Use [[#isPluginActivated|isPluginActivated('location')]]
to check if plugin active and [[#getLocationsList|getLocationsList()]] method to get list of
available locations.

See [[#book response|example]] of book API method response.
- @see http://wiki.simplybook.me/index.php/Settings#Timeframe Timeframe information
- @param Integer $eventId
- @param Integer $unitId
- @param Integer $clientId
- @param string $startDate a date string in format 'Y-m-d'
- @param string $startTime a time string in format 'H:i:s'
- @param string $endDate a date string in format 'Y-m-d'
- @param string $endTime a time string in format 'H:i:s'
- @param Integer $clientTimeOffset
- @param array|Object $additional additional params and fields.
- @param Integer $count bookings count used to make group bookings batch. This parameter can't be less than 1. (optional)
- @param Integer $batchId add booking to group bookings batch. You can't use $count and $batchId in one call. Please specify only one parameter. (optional)
- @param Array $recurringData make booking recurrent. (optional)
- @return Object
editBook ($shedulerId, $eventId, $unitId, $clientId, $startDate, $startTime, $endDate, $endTime, $clientTimeOffset, $additional)

Edit existing booking record. See [[#book|book]] API method description for more details about date/time parameters,
time zone handling and additional fields. Returns null if parameters not valid.
- @param Integer $shedulerId an id of booking to edit. See <code>[[#book|book]]</code> or <code>[[#getBookings|getBookings]]</code> API methods.
- @param Integer $eventId
- @param Integer $unitId
- @param Integer $clientId
- @param String $startDate in Y-m-d format
- @param String $startTime in H:i:s format
- @param String $endDate in Y-m-d format
- @param String $endTime in H:i:s format
- @param Integer $clientTimeOffset
- @param array|Object $additional additional params and fields.
- @return Object
addClient ($clientData, $sendEmail)

Adds new client with specified data. You can specify name, email, phone, address1, address2, city, zip,
country_id, is_email_unsubscribed, is_sms_unsubscribed.

email, phone number or both of them can be mandatory fields. You should call
getCompanyParam('require_fields') method to check which fields are required.

Method returns an error:

* -32061 Client name value is wrong
* -32062 Client email value is wrong
* -32063 Client phone value is wrong

Example:

{
name: "Frances T. Perez",
phone: "+1502-810-4521",
email: "[email protected]",
address1: "3872 Earnhardt Drive",
address2: "Louisville, KY 40219",
city: Louisville,
zip: 3872,
is_email_unsubscribed: false,
is_sms_unsubscribed: false
}
- @param Object $clientData
- @param Boolean $sendEmail
- @return Integer
editClient ($clientId, $clientData)

Edits client's record. See [[#addClient|addClient]] method description for list of available fields,
including is_email_unsubscribed and is_sms_unsubscribed for marketing consent.

Method returns an id of client's record.
- @param Integer $clientId
- @param Object $clientData
- @return Integer
changeClientPassword ($clientId, $password, $sendEmail)

Change client password and send password email changing
- @param Integer $clientId
- @param String $password
- @param Boolean $sendEmail
resetClientsPassword ($clientIds)

Resets client password and send them emails
- @param Array $clientIds
remindClientsPassword ($email)

Sends remind email for client
- @param String $email
- @return Boolean
getClientList ($searchString, $limit)

Returns list of clients associated with company. You can use either phone number, email address or name as value
for $searchString. Pass an empty string for $searchString and null for $limit

parameters to get all records. See [[#addClient|addClient]] API method for list of available fields
of client data object.
- @param String $searchString
- @param Integer $limit
- @return Array
getStatuses ()

Returns list of available statuses or an empty list if [[Plugins#Status|Status plugin]] not enabled.
- @return Array
getBookingStatus ($bookingId)

Returns status of given booking (if status plugin is enabled)
default status will be returned if bookingId does not exists
- @param Integer $bookingId
- @return Array
setStatus ($bookingId, $statusId)

Sets specified status for booking. Returns an error with code -32020 if logged in user don't have access to edit
bookings. This method does nothing if [[Plugins#Status|Status plugin]] not enabled.
- @param Integer $bookingId
- @param Integer $statusId
- @return Boolean
getRecurringSettings ($eventId)

Returns an object with recurring settings for an event. Returns false if specified event does not configured as
recurring.
- @see http://blog.simplybook.me/recurring-and-periodic-bookings/ Recurring services desription
- @param Integer $eventId
- @return Array
getTopServices ($dateStart, $dateEnd)

Returns a list with statistics for services for a period of time. This data contains number of bookings and
revenues value for each service.
- @param String $dateStart
- @param String $dateEnd
- @return Array
getTopPerformers ()

Returns a list with statistics for performers. This data contains number of bookings and revenues value for each performer.
- @return Array
getRecurringDatetimes ($eventId, $unitId, $date, $time, $recurringData, $endDateTime, $productIds)

Get list of dates for recurring booking
- @param Integer $eventId
- @param Integer $unitId
- @param String $date
- @param String $time
- @param array $recurringData
- @param String $endDateTime (optional)
- @param array $productIds
- @return array
getCountryList ()

Get list of all countries
- @return Array
getStates ()

Get list of all country states
- @return Array
getFeedbacks ($approvedOnly, $reviewsOnly, $lastOnly, $limit)

Get list of feedbacks
- @param Boolean $approvedOnly
- @param Boolean $reviewsOnly
- @param Boolean $lastOnly
- @param Integer $limit
- @return Array
getRecentActions ($lastOnly, $limit)

Returns latest actions
- @param Boolean $lastOnly
- @param Integer $limit
- @return Array
getWarnings ($lastObly)

Returns a list of objects represented system warnings. Each warning contains warning_type and warning_text
properties. warning_text property contains localized message. warning_type can be one of the values:

* '''sms_limit''' – warning indicates low amount of SMS credits
* '''sheduler_limit''' – warning indicates low amount of available bookings
- @param Boolean $lastObly Default value is '''false'''.
- @return Array
updateNotification ($type)

Mark notifications as readed
- @param String $type
getLastNotificationUpdate ($type)

Returns last update datetime
- @param String $type
- @return String
getBookingCancellationsInfo ($dateStart, $dateEnd)

Returns statistics about created bookings and cancellations for a time period. Data presented as array of hashes for
each type of operation (created or cancelled booking) groped by clients. "type" field can be either

"create", "cancel" or "nopayment_cancel". If "user_id" not specified then bookings where created or
cancelled by admin or employee. Data with type "nopayment_cancel" represents bookings cancelled
automatically by system.

Example:
3 bookings where created by admin or employee and 2 bookings where automatically cancelled by system.
[{
"cnt" : 3,
"firstname" : null,
"lastname" : null,
"login" : null,
"type" : "create",
"user_id"" : null
}, {
"cnt" : 2,
"firstname" : null,
"lastname" : null,
"login" : null,
"type" : "nopayment_cancel",
"user_id"" : null
}]
- @param String $dateStart a date string in format 'Y-m-d'. Pass null to get data from first day of current week.
- @param String $dateEnd a date string in format 'Y-m-d'. Pass null to get data filtered to last day of current week.
- @return Array
pluginApproveBookingApprove ($id)

Sets approve booking status to 'approved' if [[Plugins#Approve booking|Approve booking]] plugin enabled and returns
list of approved booking IDs. Returns false if plugin not enabled. Use [[#isPluginActivated|isPluginActivated('approve_booking')]]

API method call to check if plugin enabled.
- @param Integer $id
- @return Array
pluginApproveBookingCancel ($id)

Sets approve booking status to 'canceled' if [[Plugins#Approve booking|Approve booking]] plugin enabled and returns
true. Returns false if plugin not enabled. Use [[#isPluginActivated|isPluginActivated('approve_booking')]]

API method call to check if plugin enabled.
- @param Integer $id
- @return Boolean
pluginApproveGetPendingBookingsCount ()

Returns count of bookings pending approval if [[Plugins#Approve booking|Approve booking]] plugin enabled. Returns
0 if plugin not enabled. Use [[#isPluginActivated|isPluginActivated('approve_booking')]] API method

call to check if plugin enabled.
- @return Integer
pluginApproveGetPendingBookings ()

Returns list of objects with information about bookings pending approval if [[Plugins#Approve booking|Approve booking]]
plugin enabled. Returns empty list if plugin not enabled. Use [[#isPluginActivated|isPluginActivated('approve_booking')]]

API method call to check if plugin enabled.
- @return array
getPluginList ()

Returns a list of all plugins associated with company with status.
- @return Array
getBookingComment ($id)

Returns booking comment
- @param Integer $id
- @return String
setBookingComment ($id, $comment)

Set booking comment
- @param Integer $id
- @param String $comment
- @return Integer
getCurrentTariffInfo ()

Returns all information about current tariff (subscription). For example:

{
"name" : "gold",
"expire_date" : "2016-02-11 12:32:00",
"rest" : 41, // number of days until subscription expiration
"color" : "#fcb322"
}
- @return Array
getRegistrations ($groupBy)

Returns number of clients registrations by 'day', 'week' or 'month'. A time period depends on selected
grouping parameter:

* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months
- @param String $groupBy either 'day', 'week' or 'month'
- @return Array
getBookingStats ($groupBy)

Returns statistic about bookings count grouped by 'day', 'week' or 'month'. A time period depends on selected
grouping parameter:

* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months
- @param String $groupBy either 'day', 'week' or 'month'
- @return Array
getVisitorStats ($groupBy)

Returns statistics about page visits if plugin [[Plugins#Visitor Counter|Visitor Counter plugin]] enabled. Returns
an empty list if plugin not enabled. Use [[#isPluginActivated|isPluginActivated('counter')]] API method

call to check if plugin enabled. Results can be grouped by 'day', 'week' or 'month'. A time period depends on
selected grouping parameter:

* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months
- @param String $groupBy
- @return Array
getSocialCounterStats ($provider)

Returns social counters value for your domain
- @param String $provider
- @return Integer
getCompanyCurrency ()

Returns company's currency as three chars code (ISO 4217).
- @return String
getClientComments ($clientId, $shedulerId)

Returns list of all comments for given client
- @param Integer $clientId
- @param Integer $shedulerId
- @return Array
getClientSoapData ($clientId)

Returns current SOAP information by client id
- @param integer $clientId
- @return array
getClientSoapHistory ($clientId)

Returns SOAP history by client id
- @param integer $clientId
- @return array
getClientSoapCryptData ($clientId)

Returns current SOAP (crypt) information by client id
- @param integer $clientId
- @return array
getClientSoapCryptHistory ($clientId)

Returns SOAP (crypt) history by client id
- @param integer $clientId
- @return array
getCurrentUserDetails ()

Returns an object with information about logged in user. Note: you are responsible for implementation of some
access rights based on group property value. Most of API methods returns an error if user has low access

rights but not all. There are 4 roles:

* '''Administrator''' - have full access to the system
* '''Senior Employee''' - have access to calendar, services and providers, and can modify bookings related with user
* '''Junior Employee''' - can access caledar (but only to own bookings), services associated with user
* '''Viewer''' - have only access to calendar and services in read only mode

group property can be one of the values:

* shop_user - "Senior Employee" access role
* station_user - "Junior Employee" access role
* admin - "Administrator" access role
* viewer - "Viewer" access role
* reseller_company_admin - reserved

Example:
{ "id": 1, "login": admin, "email": "[email protected]"; "firstname": "Michail", "lastname": " ", "phone": "", "group": "admin", "is_blocked": 0, "last_access_time": "2016-06-06 17:55:51", "unit_group_id": null }
- @return Array
getCategoriesList ($isPublic)

Returns company categories list if [[Plugins#Service categories|Service categories plugin]] is activated. Returns
an error with code -32001 if plugin is not activated. Use [[#isPluginActivated|isPluginActivated('event_category')]]

API method to check if plugin activated.
- @param Boolean $isPublic
- @return Array
getLocationsList ($isPublic, $asArray)

Returns available locations for company if plugin [[Plugins#Unit location|Unit location plugin]] is activated. Return
an error with code -32001 if plugin is not activated. Use [[#isPluginActivated|isPluginActivated('location')]]

API method to check if plugin activated.

This method accepts two boolean flags as parameters. If '''isPublic''' flag is '''true''' then method returns only
public locations. If '''asArray''' flag is '''true''' method returns list of objects. Otherwise method returns
map of objects with object id as key. You can omit both parameters.
- @param Boolean $isPublic Optional. Default value is '''false'''.
- @param bool $asArray Optional. Default value is '''false'''.
- @return Array
getMembership ($membershipId)

Returns membership's data object.
- @param int $membershipId
- @return Array
getClientMembershipList ($clientId)

Returns purchased membership list
- @param Integer $clientId
- @return Array

Get api token

Get event list

Get performer list

Filter performers by service

Get closest day with available time slots

Disable not working time in calendar

Get available time slots

Check if additional fields plugin is activated

Get additional fields

Perform booking

Summary

Autorisasjon

Client API (Company public service) autorisasjon

Autorisation API Utilisateur/Admin (bedriftsadministrasjonstjeneste)

Autorisasjon fra kode på serversiden

Hente data fra Simplybook-serveren

Bruk av hemmelig API-nøkkel

Plugins for Simplybook

Kodeflyt for bestillingsfunksjonalitet

Tjenestens URL https://user-api.simplybook.me/login

getServiceUrl ($companyLogin)

getToken ($companyLogin, $apiKey)

getUserToken ($companyLogin, $userLogin, $userPassword)

getApplicationToken ($applicationApiKey)

Tjenestens URL https://user-api.simplybook.me/

getUnitList ($isVisibleOnly, $asArray, $handleClasses, $searchString)

getEventList ($isVisibleOnly, $asArray, $handleClasses, $searchString)

getCategoriesList ($isPublic)

getLocationsList ($isPublic)

getPaymentProcessorConfig ($paymentProcessor)

validatePayment ($paymentInfo, $cartId)

getBookingCart ($bookingIds)

getBookingCartInfo ($cartId, $sign)

getBookingCartStatus ($id)

confirmBookingCart ($cartId, $paymentProcessor, $sign)

confirmBooking ($id, $sign)

confirmBookingPayment ($id, $paymentProcessor, $sign)

confirmBookingBatch ($batchId, $batchType, $sign)

getBooking ($id, $sign)

getBookingDetails ($id, $sign)

isPaymentRequired ($eventId)

book ($eventId, $unitId, $date, $time, $clientData, $additional, $count, $batchId, $recurringData)

getRecurringDatetimes ($eventId, $unitId, $date, $time, $recurringData, $productIds)

hasUpcommingPromotions ()

validatePromoCode ($code, $startDateTime, $eventId, $count, $clientData)

getPromocodeInfo ($code)

getPromotionRewardInfo ($commonPromotionId, $clientId, $hash)

getUserLicenseText ()

getPrivacyPolicyText ()

getClientInfo ($clientId, $sign)

getClientInfoByLoginPassword ($login, $password)

remindClientPassword ($email)

getClientByLoginHash ($hash, $setExpired, $expireOtherHashes)

modifyClientPassword ($clientId, $data, $sign)

modifyClientInfo ($clientId, $data, $sign)

getMembershipList ()

getClientMembershipList ($filter, $clientId, $sign)

getClientBookings ($clientId, $sign, $filter)

getProductList ($filter)

getClassesList ($filter)

getCaptchaChallenge ()

rescheduleBook ($shedulerId, $sign, $startDate, $startTime, $endDate, $endTime, $additional, $clientTimeOffset, $clientTimezone)

getCompanyParam ($key)

getCompanyParams ($keys)

getCancellationPolicy ()

getTimelineType ()

calculateEndTime ($startDateTime, $eventId, $unitId, $productIds)

getWorkCalendar ($year, $month, $data)

getReservedTime ($from, $to, $eventId, $unitId, $count)

getWorkDaysInfo ($from, $to, $unitId, $eventId, $count, $productIds)

getFirstWorkingDay ($data)

getStartTimeMatrix ($from, $to, $eventId, $unitId, $count, $bookingId, $productIds)

getCartesianStartTimeMatrix ($from, $to, $eventId, $unitId, $count, $bookingId, $productIds)

getAvailableTimeIntervals ($dateFrom, $dateTo, $eventId, $unitId, $count)

getServiceAvailableTimeIntervals ($dateFrom, $dateTo, $eventId, $unitId, $count)

getReservedTimeIntervals ($dateFrom, $dateTo, $eventId, $unitId, $count, $bookingId)

getAvailableUnits ($eventId, $dateTime, $count, $unitId, $productIds)

getAnyUnitData ()

getAdditionalFields ($eventId)

getTimeframe ()