고객들이 당신의 앱을 떠나지 않고 서비스를 예약할 수 있는 기능을 즐겨보세요!

귀하의 고객들과 그분들이 원하시는 가게/서비스를 연결시켜 주는 기능을 제공하여, 귀사의 웹사이트의 사업성과 수익성을 증가시켜보세요. 저희 SimplyBookMe의 API (응용프로그램 인터페이스)를 사용하시면, 귀하의 웹 페이지에 '직접 예약하기'버튼이 설치되어, 귀하의 고객들께서 원하시는 서비스를 직접 쉽고 간편하게 예약하실 수 있습니다.

저희의 API (응용프로그램 인터페이스)를 이용하시면, 귀사의 고객들이 귀사의 서비스를 예약할 때 필요한 모든 절차를 간편하게 해결할 수 있습니다.

고객들의 귀사의 비즈니스 스케줄과 직접 연결하여, 상거래의 완전히 새롭고 손쉬운 기능을 전달합니다. 귀하의 홈페이지, 혹은 앱 상에서 고객들이 직접 예약을 완료할 수 있으므로 고객 잠재력 뿐만 아니라, 더 향상된 토털 고객 만족 서비스를 구축하실 수 있습니다.

왜 전세계의 수많은 비즈니스들이 저희 SimplyBook API (응용프로그램 인터페이스) 를 선택할까요?

명확하고 간단한 인터페이스. 최상의 방법으로 귀사만의 예약 서비스를 구축해 드립니다.
귀하께서 필요로하시는 모든 기능을 손쉽게 플러그인 할 수 있습니다.
실시간 스케줄링 – 귀하의 고객들은 24시간 언제든, 어디서건 귀하와 예약을 완료할 수 있습니다.
...또한 저희의 앱 은 수많은 유용한 기능들을 공급해 드립니다!

지원 센터

저희의 개발자 API 를 사용하여 귀사만의 예약 인터페이스를 생성하세요. 귀사의 비즈니스 특성에 따라, 가장 간단한 위젯부터 다양한 기능의 솔루션까지, 귀하가 희망하시는 시스탬을 디자인하실 수 있습니다.

SimplyBook 용용 프로그램 인터페이스는 JSON-RPC 2.0 프로토콜 을 사용합니다.

API 기반 인터페이스의 예를 참고해보시고, 이 솔루션의 소스 코드 를 읽어보시기 바람니다.

승인

SimplyBook 의 API 기능을 사용하시기 위해서는 인증이 필요합니다. SimplyBook API 의 인증을 거치시려면 액세스 키 — access-token 을 받으세요. 이 액세스 토큰을 받기 위해서는 JSON-RPC 기능에서토큰 얻기https://user-api.simplybook.me/login를 연락하여 귀하의 개인 API 키를 전달합니다. 관리자 인터페이스에서 귀하의 API 키를 복사 할 수 있습니다: '플러그인' 링크로 이동하셔서 API 플러그인 '설정' 을 선택하세요. 그리하여 SimplyBook 의 API에 대한 원격 액세스를 초기화 하여야 합니다. 귀하의 요청은 다음과 같은 머릿글을 포함해야합니다: 'X-회사-로그인', 'X-토큰'.

액세스 토큰을 얻는 것은 고객 측 모듈에서 도 가능 하나, 귀하의 서버에서 얻는것이 더 안전한 방법입니다.

귀사의 솔루션 개발을 위하여, 저희가 제시해드리는 견본들 중에 자바 스크립트 JSON-RPC-고객용 도서관 혹은 php JSON-RPC-고객용 도거관을 사용하실 수 있습니다.


Client API (Company public service) authorization

고객측의 코드에서 승인 받기

토큰-키 얻기


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

JSON-RPC-고객 초기화


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

서버 측 코드에서 권한 부여

토큰-키 얻기


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

JSON-RPC-고객 초기화


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

사용자/어드민 API (회사 행정 서비스) 승인

고객측의 코드에서 승인 받기

토큰-키 얻기


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

JSON-RPC-고객 초기화


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

서버 측 코드에서 권한 부여

토큰-키 얻기


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

JSON-RPC-고객 초기화


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

Simplybook 서버에서 데이터를 가져 오기

예약 페이지는 고객들이 필요한 서비스, 직원 및 미팅의 시간을 선택하는 곳입니다. 그 후 고객들은 고객정보를 입력하고 예약을 확인합니다. 다양한 추가 항목 입력, 그룹 또는 여러 예약들을 할 수 있습니다. 예약 페이지의 생성은 매우 단순합니다. 그 후 페이지에 추가 기능이 필요한 경우, 여기에서 Simplybook API 방법 목록을 확인하십시오

우선 먼저 표시하실 사항은 귀사의 서비스 목록 및 서비스 제공자(직원) 목록 입니다. 이 데이터들은 getEventListgetUnitList 에서 가져옵니다. 이 데이퍼들은 각 항목에 자세한 정보와 목록들이 포함되어 있어, 귀하의 선택에 따라 여러 방법으로 서비스 및 직원을 표시할 수 있습니다. 또한 직원 여과 사용은 unit_map 서비스 목록 속성을 사용하세요. 선택된 서비스를 제공 할 수 있는 직원들에 대한 정보가 포함되어 있습니다.

서비스 목록을 가져 오는 코드 예제


$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
// ), ...)

직원 목록을 가져 오는 코드 예제


$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' => 'test@gmail.com', - 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
// ), ...)

고객의 다음 절차는 원하는 서비스의 예약 날짜와 시간을 선택하는 것입니다. 현재 저희는 API 사용량의 예 에서 Bootstrap 날짜 선택기를 사용하고 있고, 또한 이는 귀하께서 원하시는 달력으로 바꾸실 수 있습니다. 스케줄 달력을 이용하시려면 getFirstWorkingDay 기능을 사용하세요. 각 직원의 ID 를 매개 변수로 이용하여 선택된 직원이 (또는 기본적으로 회사의 모든 직원이) 예약 선택된 날짜에 서비스 제공이 가능한지를 파학하는 기능입니다. 선택된 날짜상에서의 가능한 시간대를 보여주기 위하여 getWorkCalendargetStartTimeMatrix 기능을 사용합니다. 첫 번째 기능은 하루의 근무 시작 및 종료 시간, 또한 휴일에 대한 정보를 제공합니다. 그리고 두 번째 기능은 특정 날짜에 대한 예약 가능 시간들을 반환하는 기능입니다.

근무일 정보를 가져오는 코드 예제


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

시작 시간 행렬을 가져오는 코드 예제


$dateFrom = '2015-03-03';
$dateTo = '2015-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', ....),
//);

또다른 유용한 기능은 calculateEndTime 입니다. 각 서비스들에 대한 시간의 길이는 다 다르고, 각 직원들의 일일 스케줄들 또한 가자 다 다르기 때문에, 이 기능을 이용하여, 고객이 예약한 서비스 관련 예약 시간과 직원별 업무 시간들을 쉽게 파학할 수 있습니다.

예약 종료 시간을 계산하는 코드 예제


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

고객이 '예약 확인' 버튼을 클릭시 book 기능을 호출해야 합니다. 이것은 모든 필요한 승인과 Simplybook 시스템에서 새로운 예약을 등록하는 주요 기능입니다. 이름, 전화번호 등과 같은 고객 데이터를 필요로 합니다. API 기능 목록에서 이 방법의 모든 설명을 확인하십시오. book 기능은 새로운 예약의 유니크한 코드와 자세한 사항들, 혹은 문제 발생시의 오류 목록 을 담고 있습니다. 이 정보를 이용하여 편리하고 효율적인 방법으로 고객들에게 예약 결과를 전달할 수 있습니다.


API 암호 키의 사용

경우에 따라서 book 기능은 추가 정보를 요구할 수 있습니다. 예를 들면 고객의 지불을 수락하는 경우, 결제가 이미 확인 된 후에야 예약이 완료되는 경우입니다. SimplyBook API 의confirmBookng 기능은 예약 ID 와 보안 서명을 파라미터로 저장합니다. 보안 서명이 요구되는 또 다른 방법은 cancelBookng 입니다. 보안 서명 생성을 위하여 your secret API-key 이 사용되어야 합니다. 수행 할 수 있는 방법은 아래의 예 를 참조하십시오. '플러그인' 목록의 API 플러그인 '설정' 링크에서, 관리 인터페이스의 비밀 키를 찾을 수 있습니다.

비밀 API 키를 사용하여 서비스 예약 및 예약 확인의 코드 예제


$additionalFields = array(
	'6740d3bce747107ddb9a789cbb78abf3' => 'value1', 
	'b0657bafaec7a2c9800b923f959f8163' => 'value2'
);
$clientData = array(
	'name' => 'Client name',
	'email' => 'client@email.com',
	'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 '
Confirm result
'; var_dump($result); } }

추가 필드를 가져오는 코드 예제


$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
// )), ...)

Simplybook 플러그인

귀사의 특정 상 몇 가지 추가 기능을 필요로하는 경우, 저희의 추가 플러그인 일부를 활성화 할 수 있습니다. 전체 플러그인 목록은 상세한 설명과 함께 귀하의 관리 인터페이스의 '플러그인' 링크에서 참고하실 수 있습니다. 필요한 플러그인이 활성화되면 해당 API 기능들또한 역시 활성화 되고, 해당 코드를 이용하여 이들을 사용할 수 있습니다.

예약 기능 코드 흐름

loginClient.getToken(companyLogin, apiKey); 기능을 이용하여 Simplybook API 승인.


서비스 카테고리 플러그인이 isPluginActivated("event_category")에 의해 활성화 되었는지 확인 확인되었을 경우 범주 목록 표시 getCategoriesList().


getEventList()geUnitList() 기능을 이용하여 서비스 (이벤트) 및 서비스 제공자 (단위)의 목록을 확인하십시오. "unit_map" 배열이 가능한 서비스일 경우, 이 서비스는 주어진 서비스 제공자에 의해서만 제공될 수 있습니다.


모든 직원 선택 플러그인은 활성화된 isPluginActivated("any_unit")이며 "unit_map"에 정해진 서비스 제공자가 없으며, 사용자가 선택할 수 있습니다. 모든 서비스 제공자옵션 또는 서비스 제공자를 수동으로 선택할 수 있습니다. 그러나 서비스 제공자의 수동 선택은 getCompanyParam("any_unit__hide_other_units")인 경우 가능하지 않습니다.


정해진 날짜에 이용 가능한 타임 슬롯을 얻기 위해 getStartTimeMatrix ($from as current date, $to as current date, $eventId, $unitId, $count as selected participants value )를 사용하세요. 모든 직원이 선택되어진 경우 $unitId가 무효여야 합니다.


이용가능한 $unitId를 얻기 위해 모든 직원 셀렉터가 활성화이고 모든 직원getAvailableUnits($eventId, $dateTime, $count)로 선택된 경우


추가 항목 플러그인이 활성화되어있고 isPluginActivated("event_field")getAdditionalFields($eventId) 기능이 고객 기입 목록을 얻기 위한 경우.


예약을 하기 위한 book($eventId, $unitId, $date, $time, $clientData, $additional, $count, $batchId).


Api 토큰 얻기
SimplyBook의 API(응용프로그램 인터페이스) 시스템을 사용하기 위하여 인증이 필요합니다SimplyBook 의 API 권한을 부여받으려면, 액세스 키와 mdash; 액세스 토큰이 필요합니다. 엑세스 토큰을 얻기 위해서는, 먼저https://user-api.simplybook.me/login 로 가신 후 JSON-RPC 방식getToken 을 이용하셔서 귀하의 개인용 API 키를 통과하세요. 관리자 인터페이스에서 귀하의 API 키를 복사하신후, ‘플러그인’ 링크로 가셔서 API 플러그인 ‘세팅’을 선택하세요.
var token = loginClient.getToken(companyLogin, apiKey);
방법 결과
응답 본문
HTTP 요청
서비스 예약 목록 가져오기
귀하께서 인증 토큰을 받으셨습니다. 이제 JSON RPC 고객 을 생성하시고, http 머릿말을 설정하신 후, SimplyBook 서버에서 데이터를 가져오기 위하여 해당 고객을 사용하십시오. 서비스 리스트를 불러오기 위해서, 아래의 코드 예제에 나와있는 다음 기능getEventList()을 이용하십시오.
var events = client.getEventList();
방법 결과
응답 본문
HTTP 요청
서비스 공급자 (직원) 목록 가져오기
또한, 귀사의 모든 서비스 공급자 (직원들) 목록을 불러와야 합니다. 이를 위해서 이 기능getUnitList()을 사용하십시오.
var units = client.getUnitList();
방법 결과
응답 본문
HTTP 요청
서비스별로 직원을 나누기 (필터링)
이제 귀하의 고객들께서 예약을 원하는 서비스와 직원을 선택할수 있도록 합니다. 예약 가능한 모든 서비스는, 시스템상에서 특정 직원, 혹은 전 직원에게 연결되어 있습니다. 그러므로, 귀하께서는 먼저 시스템상에서, 서비스별로 직원을 나누는 작업을 먼저 완료하십시오. 이를 위하여 unit_map의 서비스 객체의 매개 변수를 이용하세요. 또한 아래의 코드 예제를 참조 하십시오.
사용 가능한 예약 시간에 한하여, 오늘로부터 가장 가까운 날짜를 먼저 선택합니다
귀하의 고객이 서비스 예약과 직원 선택을 완료 하셨으면, 귀하께서는 해당 직원의 첫 번째 근무일을 지정하시고, 다음 기능getFirstWorkingDay()을 이용하여, 해당 근무일을 '날짜선택 활성 날짜'로 세팅 하십시오.
var firstWorkingDay = client.getFirstWorkingDay(performerId);
방법 결과
응답 본문
HTTP 요청
예약 달력에서 '비 근무시간'을 비활성화 시키기
귀하의 '날짜선택' 기능에서 직원들의 근무 가능 날짜를 설정할수 있고, 근무 달력을 토대로한 데이터를 이용하여 '비 근무일' 또한 비활성화 시킬 수 있습니다. 이곳getWorkCalendar()을 클릭하셔서, 이 기능이 코드 예제에서 어떻게 이루어 지는지 확인해 보세요.
workCalendar = client.getWorkCalendar(year, month, performerId);
방법 결과
응답 본문
HTTP 요청
예약 가능한 시간대 가져오기
예약 날짜가 선택된 후, 해당 날짜에서 예약 가능한 시간 간격을 설정합니다. 이 기능 getStartTimeMatrix() 을 이용하여 '예약 시작 가능 시간'의 목록을 가져옵니다.
var startMatrix = client.getStartTimeMatrix(from, to, eventId, unitId, count)
방법 결과
응답 본문
HTTP 요청
추가 필드 플러그인이 활성화 되었는지 확인
이제, 다음 단계에서 고객들께 무었이 표시되어야 할지를 설정하기 위하여, 추기 필드 플러그인이 활성화 되었는지 확인합니다. 이IsPluginActivated() 기능을 이용하십시오.
var additionalFieldsActivated = client.isPluginActivated('event_field');
방법 결과
응답 본문
HTTP 요청
추가 필드를 설정
추가 필드 플러그인이 활성화 되었을 경우 getAdditionalFields()기능을 통하여 추가 필드 목록 페이지를 로드 시키고, 고객 세부 정보 양식에 추가하십시오.
방법 결과
응답 본문
HTTP 요청
예약을 수행
고객이 추기 필드에 필요한 정보를 모두 채운 후, book() 기능을 통하여 예약 과정을 시작합니다.
고객명
고객 이메일
고객 전화
방법 결과
응답 본문
HTTP 요청
요약
저희 SimplyBook 의 유용한 API 기능에 관하여 설명드렸습니다. 사용 가능한 모든 API 기능들은 이곳에서 살펴보실 수 있습니다. 또한 궁금하신 사항이 있으시면 언제든지 연락해 주십시오. 어떤 질문이든 환영합니다!
읽어 주셔서 감사합니다!

서비스 URL  https://user-api.simplybook.me/

  • getUnitList ($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
  • 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, , $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 $clientData eg. {name: 'Name', email: 'test@gmail.com', phone: '+38099999999'}
    • @param array
    • @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)

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

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

    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
    • @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
  • 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)

    Get client information by client login hash
    • @param String $hash
    • @return Object
  • 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 $filter
    • @return array
  • membershipCheckClientAccess ($eventId, $clientId, $clientSign, $date, $count)

    Checks if client has access to book with $eventId at $startDateTime
    • @param Integer $eventId
    • @param Integer $clientId
    • @param String $clientSign signature = md5($clientId . $clientHash . $secretKey)
    • @param String $date
    • @param int $count
    • @return Boolean
  • makeMembershipPayment ($membershipId, $clientId, $sign)

    Creates membership payment by membership id and client data
    • @param Integer $membershipId
    • @param Integer $clientId
    • @param String $sign signature = md5($clientId . $clientHash . $secretKey)
    • @return Object
  • 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
  • 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
  • getTimelineType ()

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

    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
    • @return String
  • getWorkCalendar ($year, $month, )

    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
    • @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)

    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)
    • @return Object
  • getFirstWorkingDay ()

    Returns first working date for unit
    • @param Integer
    • @return String
  • getStartTimeMatrix ($from, $to, $eventId, $unitId, $count)

    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
    • @return Object
  • 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, , $count)

    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
    • @param Integer $count
    • @return Object
  • getAvailableUnits ($eventId, $dateTime, $count)

    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 Integer $count
    • @return Array
  • filterAvailableUnits ($eventId, $dateTime, , $count)

    Returns list of available unit ids for specified date and service from provided $unitIds list.
    You can use this method with location plugin.
    Returns 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 Array
    • @param Integer $count
    • @return Array
  • 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

서비스 URL  https://user-api.simplybook.me/admin

  • 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'
    * '''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
  • getBookingsZapier ()

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

    Returns detailed bookings object by booking id. See [[#getBookingDetails_response|response example]].
    • @param integer $id booking id
    • @return Array
  • 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 [[#createBatch|createBatch]] API method.
    • @param Array $bookingIds ids of bookings included to batch.
    • @return bool
  • book ($eventId, $unitId, $clientId, $startDate, $startTime, $endDate, $endTime, $clientTimeOffset, , $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
    • @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, )

    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 [[#book|book]] or [[#getBookings|getBookings]] 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
    • @return Object
  • addClient ($clientData, $sendEmail)

    Adds new client with specified data. You can specify name, email, phone, address1, address2, city, zip,
    country_id. If client record with specified data exists method will return an id of this record. Otherwise data
    will be stored to database and method will return an id of newly created record. NOTE: name is mandatory field.
    Also 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: "FrancesTPerez@teleworm.us",
    address1: "3872 Earnhardt Drive",
    address2: "Louisville, KY 40219",
    city: Louisville,
    zip: 3872
    }
    • @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.
    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)

    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)
    • @return Array
  • addDeviceToken ($token, $device)

    Subscribe a mobile device to push notifications service. Device will recieve notifications about new bookings or
    changes in already created bookings. Use either 'apple' or 'android' for device
    parameter.
    • @param String $token a device token string
    • @param String $device a device type ('android' or 'apple')
    • @return bool
  • deleteDeviceToken ($token)

    Unsubscribe from push notifications service.
    • @param String $token device token
    • @return bool
  • getCountryList ()

    Get list of all countries
    • @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
  • 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": "admin@mycoolcompany.com";
    "firstname": "Michail",
    "lastname": " ",
    "phone": "",
    "group": "admin",
    "is_blocked": 0,
    "last_access_time": "2016-06-06 17:55:51",
    "unit_group_id": null
    }
    • @return Array
  • getUserPhoneValidationInfo ($userId, $number)

    Get user db data (id, phone, is_validated)
    • @param int $userId
    • @param string $number
  • 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
  • updateClientSoapData ($clientId, $data)

    Updates SOAP information if it was changed
    • @param integer $clientId
    • @param array $data
  • 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
  • updateClientSoapCryptData ($clientId, $data)

    Updates SOAP (crypt) information if it was changed
    • @param integer $clientId
    • @param array $data
  • deleteCategories ($categories)

    Delete given set of categories if it is possible
    Returns an error with code -32001 if plugin is not activated. Use [[#isPluginActivated|isPluginActivated('event_category')]]
    API method to check if plugin activated.
    Returns an error with code -32101 if trying to delete default category and
    an error with code -32102 if trying to delete all categories
    Return an error with code -32002 if no $categories provided
    • @param array $categories
    • @return bool
  • deleteLocations ($locations)

    Delete given set of locations if it is possible
    Returns an error with code -32001 if plugin is not activated.
    Use [[#isPluginActivated|isPluginActivated('location')]] API method to check if plugin activated.
    Returns an error with code -32074 if trying to delete default location and
    an error with code -32075 if trying to delete all locations
    Returns an error with code -32002 if no $locations provided
    • @param array $locations
    • @return bool
  • addServiceProvider ($data)

    Adds new service provider

    Example:

    {
    "name" : "newtagg1 - 4",
    "description" : "Description - 1",
    "phone" : "1234567890",
    "email" : "test@test.com",
    "qty" : "2",
    "is_visible" : 1,
    "is_active" : 1,
    "position" : 2,
    "position_in_location" : null,
    "locations" : [ 3 ],
    "services" : [ 1, 2 ]
    }
    • @param array $data
    • @return Array
  • editServiceProvider ($id, $data)

    Edit service provider
    there is no way to delete provider via API, in this case set is_active = 0


    Example:

    {
    "name" : "newtagg1 - 4",
    "description" : "Description - 1",
    "phone" : "1234567890",
    "email" : "test@test.com",
    "qty" : "2",
    "is_visible" : 1,
    "is_active" : 1,
    "position" : 2,
    "position_in_location" : null,
    "locations" : [ 3 ],
    "services" : [ 1, 2 ]
    }
    • @param integer $id
    • @param array $data
    • @return Array
  • addService ($data)

    Adds new service

    Example:


    {
    "name":"Service name",
    "duration":"60",
    "hide_duration":"0",
    "description":"Service description",
    "is_public":"1",
    "is_active":"1",
    "position":"1",
    "file_id":null,
    "seo_url":null,
    "is_recurring":"0",
    "picture":null,
    "picture_sub_path":null,
    "picture_path":null,
    "recurring_settings":{
    "days":7,
    "repeat_count":1,
    "type":"fixed",
    "mode":"skip",
    "is_default_settings":true,
    "days_names":[
    "Friday",
    "Saturday",
    "Sunday"
    ]
    },
    "units":[
    2, 3
    ],
    "price":10,
    "currency":"USD",
    }
    • @param array $data
    • @return Array
  • editService ($id, $data)

    Edit service
    there is no way to delete service via API, in this case set is_active = 0


    Example:

    {
    "name":"Service name",
    "duration":"60",
    "hide_duration":"0",
    "description":"Service description",
    "is_public":"1",
    "is_active":"1",
    "position":"1",
    "file_id":null,
    "seo_url":null,
    "is_recurring":"0",
    "picture":null,
    "picture_sub_path":null,
    "picture_path":null,
    "recurring_settings":{
    "days":7,
    "repeat_count":1,
    "type":"fixed",
    "mode":"skip",
    "is_default_settings":true,

    "days_names":[
    "Friday",
    "Saturday",
    "Sunday"
    ]
    },
    "units":[
    2, 3
    ],
    "categories":[
    2
    ]
    "price":10,
    "currency":"USD",
    }
    • @param integer $id
    • @param array $data
    • @return Array
  • editServiceCategory ($id, $data)

    Edit service category

    Example:


    {
    "name":"Category name",
    "description":"Category description",
    "is_default":1,
    "position":0,
    • @param integer $id
    • @param array $data
    • @return Array
  • deleteServiceCategory ($id)

    Delete service category
    • @param integer $id
    • @return Array
  • deleteServiceProviderLocation ($id)

    Delete service provider location
    • @param integer $id
    • @return Array
  • addServiceCategory ($data)

    Edit service category

    Example:


    {
    "name":"Category name",
    "description":"Category description",
    "is_default":1,
    "position":0,
    • @param array $data
    • @return Array
  • editServiceProviderLocation ($id, $data)

    Edit service provider location

    Example:


    {
    "title":"Location mame",
    "description":"Locartion description",
    "address1":"Address 1",
    "address2":"Address 2",
    "city":"City",
    "zip":"12345",
    "country_id":"US",
    "lat":"0.00000000000000000000",
    "lng":"0.00000000000000000000",
    "phone":"11234567",
    "position":"1",
    "is_default":"1"
    }
    • @param integer $id
    • @param array $data
    • @return Array
  • addServiceProviderLocation ($data)

    Add service provider location

    Example:


    {
    "title":"Location mame",
    "description":"Locartion description",
    "address1":"Address 1",
    "address2":"Address 2",
    "city":"City",
    "zip":"12345",
    "country_id":"US",
    "lat":"0.00000000000000000000",
    "lng":"0.00000000000000000000",
    "phone":"11234567",
    "position":"1",
    "is_default":"1"
    }
    • @param array $data
    • @return Array
  • getMembership ($membershipId)

    Returns membership's data object.
    • @param int $membershipId
    • @return Array
  • 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
  • setWorkDayInfo ($info)

    Set work day schedule for company|service|provider for week_day|date

    Example:

    {
    "start_time":"10:00",
    "end_time":"18:00",
    "is_day_off":0,
    "breaktime":[{"start_time":"14:00","end_time":"15:00"}],
    "index":"1",
    "name":"Monday",
    "date":"",
    "unit_group_id":"",
    "event_id":""
    }


    index is 1-7 for Monday - Sunday (used for weekly settings)
    date is used to set worktime for special date
    unit_group_id is provider id
    event_id is service id
    if unit_group_id and event_id not passed then it set data for company
    • @param array $info
    • @return boolean true on success
  • deleteSpecialDay ($date, $params)

    Delete special date if set

    Example:

    {
    "unit_group_id":"",
    "event_id":""
    }
    • @param string $date 'Y-m-d'
    • @param array $params = null
    • @return boolean true on success
  • getCompanyWorkCalendarForYear ($year)

    Returns company special days and vacations
    • @param Integer $year
    • @return Object
  • getServiceWorkCalendarForYear ($year, $eventId)

    Returns special days and vacations, defined for given service (event)
    • @param Integer $year
    • @param Integer $eventId
    • @return Object
  • getCompanyVacations ()

    Get list of company vacations in format array(vacation_id => array())
    • @return array
  • getServiceVacations ($serviceId)

    Get list of service vacations
    • @param Integer $serviceId
    • @return array
  • getPerformerVacations ($performerId)

    Get list of performer vacations
    • @param Integer $performerId
    • @return array
  • getCompanyVacation ($vacationId)

    Get company vacation by id
    • @param Integer $vacationId
    • @return array vacation table row data
  • getServiceVacation ($vacationId, $serviceId)

    Get service vacation by id
    • @param Integer $vacationId
    • @param Integer $serviceId
    • @return array vacation table row data
  • getPerformerVacation ($vacationId, $performerId)

    Get service vacation by id
    • @param Integer $vacationId
    • @param Integer $performerId
    • @return array vacation table row data
  • saveCompanyVacation ($data)

    Save company vacation data
    (create or update table depending on 'id' param existing in $data)
    • @param array $data
    • @return Integer id of saved vacation
  • saveServiceVacation ($data, $serviceId)

    Save company vacation data
    (create or update table depending on 'id' param existing in $data)
    • @param array $data
    • @param Integer $serviceId
    • @return Integer id of saved vacation
  • savePerformerVacation ($data, $performerId)

    Save company vacation data
    (create or update table depending on 'id' param existing in $data)
    • @param array $data
    • @param Integer $performerId
    • @return Integer id of saved vacation
  • deleteCompanyVacation ($vacationId)

    Delete company vacation with all it's bindings
    (including created special days in work_day_special table)
    • @param Integer $vacationId
  • deleteServiceVacation ($vacationId, $serviceId)

    Delete service vacation with all it's bindings
    (including created special days in work_day_special table)
    • @param Integer $vacationId
    • @param Integer $serviceId
  • deletePerformerVacation ($vacationId, $unigGroupId)

    Delete performer vacation with all it's bindings
    (including created special days in work_day_special table)
    • @param Integer $vacationId
    • @param Integer $unigGroupId
  • getClassesList ($isVisibleOnly, $asArray)

    Returns company's classes list. If $asArray is false then method returns a map with event id as key
    and details object as value. If parameter set to true then method returns a list sorted by 'position' property of
    class's details object.
    • @param Boolean $isVisibleOnly
    • @param Boolean $asArray
    • @return Array
  • deleteClasses ($services)

    • @internal Delete given classes if it is possible
    • @param array $services
  • getProductList ($filter)

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

    Delete given product or products if it is possible, otherwise set it as inactive
    The $id param can be int or array of int
    • @param integer
    • @return bool
  • getFeedbackReport ($request)

    Get paginated data for Feedback report
    The following filters can be provided in request param:
    Date date_from, date_to
    Integer from 1 to 5 rate_from, rate_to
    String name, subject, message

    Report can be ordered by one of the following fields:
    date, rate, name, message, subject, answer

    Return data in the following format:
    array(
    'data' => $data,
    'metadata' => array(
    'items_count'
    'pages_count'
    'page'
    'on_page'
    )
    or Api_Service_Exception in error case
    • @param Api_Paginator_Request $request
    • @return array
  • getPromotionList ($isVisibleOnly, $asArray, $promotionType)

    Get detailed list of promotions (new)
    • @param bool $isVisibleOnly
    • @param bool $asArray
    • @param string $promotionType = 'discount' / 'gift_card' / null
    • @return array
  • getPromotionInstanceList ($promotionType, $asArray)

    Get all list of promotion instances
    • @param string $promotionType = 'gift_card' | 'discount'
    • @param bool $asArray
    • @return array
  • getPromotionDetails ($id)

    Return promotion detailed info
    • @param integer $id
    • @return array
  • getStaticPageList ()

    Get static page list
    • @return array
  • 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
  • getTimelineType ()

    Returns company timeline type
    • @return String
  • getEventList ($isVisibleOnly, $asArray, $handleClasses, $searchString)

    Returns company's events list. If $asArray is false then method returns a map with event id as key
    and details object as value. If parameter set to true then method returns a list sorted by 'position' property of
    event's details object.
    • @param Boolean $isVisibleOnly
    • @param Boolean $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
  • getUnitList ($isVisibleOnly, $asArray, $handleClasses, $searchString)

    Returns list of service performers. If $asArray is false then method returns a map with event id as
    key and details object as value. If parameter set to true then method returns a list sorted by 'position' property
    of event's details object.
    • @param Boolean $isVisibleOnly
    • @param Boolean $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)

    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
  • calculateEndTime ($startDateTime, $eventId, $unitId)

    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
    • @return String
  • getWorkCalendar ($year, $month, )

    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
    • @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)

    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)
    • @return Object
  • getFirstWorkingDay ()

    Returns first working date for unit
    • @param Integer
    • @return String
  • getStartTimeMatrix ($from, $to, $eventId, $unitId, $count)

    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
    • @return Object
  • 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, , $count)

    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
    • @param Integer $count
    • @return Object
  • getAvailableUnits ($eventId, $dateTime, $count)

    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 Integer $count
    • @return Array
  • filterAvailableUnits ($eventId, $dateTime, , $count)

    Returns list of available unit ids for specified date and service from provided $unitIds list.
    You can use this method with location plugin.
    Returns 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 Array
    • @param Integer $count
    • @return Array
  • 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

서비스 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]].
    • @param String $companyLogin a company identifier (login)
    • @param String $userLogin user's login associated with company
    • @param String $userPassword user's password
    • @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

서비스 URL  https://user-api.simplybook.me/catalog

  • getCompanyList ($filter, $from, $limit)

    Returns companies list
    $filter filter params. Object that contains following params

    'search_string': String,
    'service_name': String,
    'company_name': String,
    'company_address': String,
    'category_id': Integer,
    'tag_ids': [Integer, Integer, ...],
    'tags': String,
    'country_id': String,
    'city_id': String,
    'nearby': {
    'radius': Integer,
    'center': {
    'lat': Number,
    'lng': NUmber
    }
    }

    Use tag_ids OR tags
    • @param Object $filter filter object
    • @param Integer $from from position
    • @param Integer $limit rows limit
    • @return array
  • getPromotionList ($filter, $from, $limit)

    Returns active promotion list
    $filter filter params. Object that contains following params

    'search_string': String,
    'service_name': String,
    'company_name': String,
    'company_address': String,
    'tag_ids': [Integer, Integer, ...],
    'tags': String,
    'country_id': String,
    'city_id': String,
    'nearby': {
    'radius': Integer,
    'center': {
    'lat': Number,
    'lng': NUmber
    }
    }

    Use tag_ids OR tags
    • @param Object $filter filter object
    • @param Integer $from from position
    • @param Integer $limit rows limit
    • @return array
  • getPromotionListByIds ()

    Returns active promotion list
    • @param array
    • @return array
  • getCompanyCount ($filter)

    Returns total companies count with specified filter
    $filter filter params. Object that contains following params

    'search_string': String,
    'service_name': String,
    'company_name': String,
    'company_address': String,
    'tag_ids': [Integer, Integer, ...],
    'tags': String,
    'country_id': String,
    'city_id': String,
    'nearby': {
    'radius': Integer,
    'center': {
    'lat': Number,
    'lng': NUmber
    }
    }

    Use tag_ids OR tags
    • @param Object $filter filter object
    • @return array
  • getPromotionCount ($filter)

    Returns total active promotions count with specified filter
    $filter filter params. Object that contains following params

    'search_string': String,
    'service_name': String,
    'company_name': String,
    'company_address': String,
    'tag_ids': [Integer, Integer, ...],
    'tags': String,
    'country_id': String,
    'city_id': String,
    'nearby': {
    'radius': Integer,
    'center': {
    'lat': Number,
    'lng': NUmber
    }
    }

    Use tag_ids OR tags
    • @param Object $filter filter object
    • @return array
  • getTopCountries ()

    Returns country list as Array order by company count in country
    • @return Array [{'id': ..., 'country': ...., 'count': ....}, ...]
  • getTopCities ()

    Returns city list as Array order by company count in city
    • @return Array [{'id': ..., 'city': ...., 'country_id': ...., 'count': .....}, ....]
  • getCountries ()

    Returns a list of objects with just two properties each: id and country. An id
    is a two character string with ISO 3166-1 country code.
    • @return Array [{'id': ..., 'country': ...., 'count': ....}, ...]
  • getCities ($country, $withActiveCompany)

    Returns a list of objects. If $country parametr specified then method returns only cities of this
    country. Each object in list has 4 properties:

    * id - number. A unique identificator of city. You should use it as filter options in methods getCompanyList.
    * city - string. A city name.
    * count_id - string. Two chars ISO 3166-1 country code.
    * count - number.

    Example:

    [{
    "cnt" : 7,
    "country_id"" : "GB",
    "id" : 4607,
    "name" : "Uxbridge"
    },
    ...]
    • @param String $country Optional. A two character ISO 3166-1 country code.
    • @param bool $withActiveCompany
    • @return Array [{'id': ..., 'city': ...., 'country_id': ...., 'count': .....}, ....]
  • getTags ($filter)

    Returns tags list
    $filter filter params. Object that contains following params

    'tag_ids': [Integer, Integer, ...],
    'tags': String,
    'country_id': String,
    'city_id': String

    Use tag_ids OR tags
    • @param Object $filter filter object
    • @return Array [{'id': ..., 'tag': ...}, ....]
  • getCompanyInfo ($login)

    Returns company information by company login
    • @param String $login
    • @return Object
  • getPromotionInfo ($id, $feedbackFrom, $feedbackCount)

    Returns promotion information by id
    • @param Integer $id
    • @param Integer $feedbackFrom = 0
    • @param Integer $feedbackCount = 100
    • @return Object
  • getRelatedPromotions ($id, $count)

    Returns related promotions by given promotion id
    • @param Integer $id
    • @param Integer $count = 10
    • @return Array
  • getCompanyReviews ($login, $count, $offset)

    Returns a list of company's review objects.

    [{
    "company_id" : 86409,
    "domain" : "simplybook.me",
    "feedback_datetime" : "2015-10-27 13:06:57",
    "feedback_id" : 4623,
    "feedback_link" : "",
    "id" : 17384,
    "image" : "http://graph.facebook.com/1020443689023222/picture",
    "link" : "https://www.facebook.com/app_scoped_user_id/1020443689023222/",
    "message" : "Brilliant!",
    "name" : "Simply Booker",
    "provider" : "",
    "provider_data" : "...", // String. An object encoded with PHP's serialize method.
    "rate" : 5, // 0 to 5 rate
    "status" : "approved", // 'new' or 'approved'
    "subject" : "Good",
    "with_comment" : 1
    },
    ...]
    • @see http://php.net/serialize
    • @param String $login
    • @param Integer $count
    • @param Integer $offset
    • @return Object
  • getCompanyReviewsCount ($login)

    Returns company's reviews count
    • @param String $login
    • @return Integer
  • getCompanyReview ($login, $reviewId)

    Returns a company's review objects.
    • @param String $login
    • @param Integer $reviewId
    • @return Object
  • getClientReviewsLikes ($clientId, $clientProvider)

    Returns a list of company's review likes.
    • @param String $clientId
    • @param String $clientProvider
    • @return Object
  • addCompanyReview ($login, $subject, $message, $rate, $provider, $accessToken)

    Adds company review
    • @param String $login
    • @param String $subject
    • @param String $message
    • @param Integer $rate
    • @param String $provider
    • @param String $accessToken
    • @return Boolean
  • addPromotionReview ($promotionId, $subject, $message, $rate, $provider, $accessToken)

    Add promotion review
    • @param Integer $promotionId
    • @param String $subject
    • @param String $message
    • @param Integer $rate
    • @param String $provider
    • @param String $accessToken
    • @return Boolean
  • getPromotionReviews ($promotionId)

    Returns promotion reviews list
    • @param Integer $promotionId
    • @return Object
  • getRecentPromotions ($count)

    Returns list of promotions ordered by date DESC
    • @param Integer $count
    • @return Array
  • getRecentFeedbacks ($count)

    Returns list of feedbacs ordered by date DESC
    • @param Integer $count
    • @return Array
  • getRecentCompanies ($count)

    Returns list of companies ordered by date DESC
    • @param Integer $count
    • @return Array
  • getCategories ()

    Returns all categories as list of objects. Each category can have a subcategories. Each subcategory contains parent
    category id in company_category_id field. For top level categories this field is null and
    is_header field is true.


    Example:

    [{
    "company_category_id": null,
    "id": "1",
    "image": "/common/images/category_icons/car.png",
    "is_active": "1",
    "is_header": "1",
    "name": "Cars",
    },
    {
    "company_category_id": "1",
    "id" = 11;
    "image": null,
    "is_active": "1",
    "is_header": "0",
    "name": "Car wash",
    },
    ...]
    • @return Array
  • getFeedbackList ()

    Get list of ALL simplybook feedbacks
    • @return Array
  • getCompanyPromotionList ($promotionCompanyLogin, $count)

    Returns a list of promotions objects associated with specified company. If company doesn't have any promotions or
    [[Plugins#Simply_Smart_Promotions|Simply Smart Promotions plugin]] not active for this company method returns an
    empty list.
    • @param String $promotionCompanyLogin
    • @param Integer $count Optional. Maximum amount of objects in response. Default value is 100.
    • @return Array
  • getUserLocation ($ip)

    Returns user location info
    • @param String $ip optional
    • @return Object
  • getAutocompleete ($filter, )

    Returns suggestions for autocompeter
    $filter filter params. Object that contains following params

    'search_string': String,
    'service_name': String,
    'company_name': String,
    'company_address': String,
    'category_id': Integer,
    'tag_ids': [Integer, Integer, ...],
    'tags': String,
    'country_id': String,
    'city_id': String,
    'nearby': {
    'radius': Integer,
    'center': {
    'lat': Number,
    'lng': NUmber
    }
    }

    Use tag_ids OR tags
    • @param Object $filter filter object
    • @param Boolean
    • @return array
  • deleteClientFeedbacks ($gdprDataSerialized)

    Anonymize client feedbacks and feedback likes
    according to GDPR client's right to be forgotten
    • @param array $gdprDataSerialized