SimplyBook.me

User API guide/uk: Difference between revisions

← Older edit
VisualWikitext
Created page with "= '''CLIENT API ([https://simplybook.me/api/doc#/admin ДЕРЖАВНА СЛУЖБА]) АВТОРИЗАЦІЯ''' = <br><br> == '''Авторизація з боку клієнта''' == <br><br> '''Отримання токен-ключа'''. <br><br> <nowiki>var loginClient = new JSONRpcClient({ 'url': 'https://user-api.simplybook.me' + '/login', 'onerror': function (error) {}, }); var token = loginClient.getToken(YOUR_COMPANY_LOGIN, YOUR_API_KEY);</nowiki> <br><br>..."
No edit summary
 
(8 intermediate revisions by the same user not shown)
Line 24: Line 24:




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


<div lang="en" dir="ltr" class="mw-content-ltr">
= '''ВИКОРИСТАННЯ СЕКРЕТНОГО КЛЮЧА API''' =
='''USING OF API SECRET KEY'''=
<br><br>
<br><br>
In some cases the book method may require the confirmation, e.g. if your accept payments from clients you confirm booking only after the payment is already came. The Simplybook API confirmBookng method takes booking-id and secure signature as params (another method which requires secure signature is cancelBookng). For the secure signature generation your secret API-key should be used. See how it can be done in the example below. You can find the secret key at admin interface under 'Settings' link of API Custom Feature in 'Custom Features' list.
У деяких випадках метод бронювання може вимагати підтвердження, наприклад, якщо ви приймаєте платежі від клієнтів, ви підтверджуєте бронювання тільки після того, як платіж вже надійшов. Метод Simplybook API confirmBookng приймає ідентифікатор бронювання та безпечний підпис як параметри (інший метод, який вимагає безпечного підпису, - cancelBookng). Для генерації безпечного підпису слід використовувати ваш секретний ключ API. Дивіться, як це можна зробити, у прикладі нижче. Секретний ключ можна знайти в адміністративному інтерфейсі за посиланням «Налаштування» в розділі «Налаштування API» у списку «Налаштування».
<br><br>
<br><br>
</div>


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


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


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


<div lang="en" dir="ltr" class="mw-content-ltr">
= '''ПЕРСОНАЛЬНІ ФУНКЦІЇ SIMPLYBOOK''' =
='''SIMPLYBOOK CUSTOM FEATURES'''=
<br><br>
<br><br>
If your company specific requires some additional functionality you can activate some of our additional Custom Features. The complete Custom Features list with detailed description is avaiable in your admin interface under the 'Custom Feature' link. After the necessary Custom Feature is enabled the corresponding API methods will be activated so you can use them in your code.
Якщо ваша компанія потребує додаткових функцій, ви можете активувати деякі з наших додаткових функцій. Повний перелік функцій з докладним описом доступний в адміністративному інтерфейсі за посиланням «Custom Feature» (Додаткові функції). Після увімкнення необхідної функції будуть активовані відповідні методи API, які ви зможете використовувати у своєму коді.
<br><br><br>
<br><br><br>
='''BOOKING FUNCTIONALITY CODEFLOW'''=
= '''ФУНКЦІОНАЛЬНІСТЬ БРОНЮВАННЯ КОДОВИЙ ПОТІК''' =
<br><br>
<br><br>
Authorize in Simplybook API using '''loginClient.getToken(companyLogin, apiKey);''' function.
Авторизуйтесь в Simplybook API за допомогою функції '''loginClient.getToken(companyLogin, apiKey);'''.
</div>




<div lang="en" dir="ltr" class="mw-content-ltr">
Перевірте, чи активована функція «Категорії послуг» за допомогою [https://simplybook.me/en/api/doc#isPluginActivated isPluginActivated("event_category")]. Якщо так, то відобразіть список категорій [https://simplybook.me/en/api/doc#getCategoriesList getCategoriesList()].
Check if Service categories Custom Feature is activated by [https://simplybook.me/en/api/doc#isPluginActivated isPluginActivated("event_category")] if yes then display list of categories [https://simplybook.me/en/api/doc#getCategoriesList getCategoriesList()].
</div>




<div lang="en" dir="ltr" class="mw-content-ltr">
Отримати список послуг (подій) та виконавців (одиниць) за допомогою функцій [https://simplybook.me/en/api/doc#getEventList getEventList()] та [https://simplybook.me/en/api/doc#getUnitList getUnitList()]. Якщо для послуги доступний масив "unit_map", це означає, що ця послуга може бути надана тільки зазначеними виконавцями.
Get list of services (events) and performers (units) using [https://simplybook.me/en/api/doc#getEventList getEventList()] and [https://simplybook.me/en/api/doc#getUnitList getUnitList()] functions. If "unit_map" array is available for service it means this service can be provided by given performers only.
</div>






<div lang="en" dir="ltr" class="mw-content-ltr">
Якщо активовано будь-яку спеціальну функцію вибору співробітника [https://simplybook.me/en/api/doc#isPluginActivated isPluginActivated("any_unit")] і в масиві "unit_map" не встановлено спеціальний термін для пари "послуга-виконавець", то користувачеві слід дозволити вибрати будь-який варіант постачальника або вибрати постачальника вручну. Але ручний вибір виконавців не повинен бути можливим, якщо активовано [https://simplybook.me/en/api/doc#getCompanyParam getCompanyParam("any_unit__hide_other_units")].
If Any Employee Selector Custom Feature is activated [https://simplybook.me/en/api/doc#isPluginActivated isPluginActivated("any_unit")] and no special duration is set for service-performer pair in "unit_map" array then user should be allowed to select Any provider option or choose provider manually. But manual selection of performers should not be possible if [https://simplybook.me/en/api/doc#getCompanyParam getCompanyParam("any_unit__hide_other_units")] is enabled.
</div>




<div lang="en" dir="ltr" class="mw-content-ltr">
Використовуйте [https://simplybook.me/en/api/doc#getStartTimeMatrix getStartTimeMatrix ($from як поточну дату, $to як поточну дату, $eventId, $unitId, $count як значення вибраних учасників)], щоб отримати доступні часові слоти для заданої дати. '''$unitId''' повинен бути нульовим, якщо вибрано опцію «Будь-який співробітник».
Use [https://simplybook.me/en/api/doc#getStartTimeMatrix getStartTimeMatrix ($from as current date, $to as current date, $eventId, $unitId, $count as selected participants value )] to get available timeslots for given date. '''$unitId''' should be null if Any employee option is selected.
</div>




<div lang="en" dir="ltr" class="mw-content-ltr">
Якщо активний селектор «Будь-який співробітник» і було вибрано будь-якого співробітника, викличте [https://simplybook.me/en/api/doc#getAvailableUnits getAvailableUnits($eventId, $dateTime, $count)], щоб отримати доступний $unitId
If Any Employee selector is active and Any employee was selected call [https://simplybook.me/en/api/doc#getAvailableUnits getAvailableUnits($eventId, $dateTime, $count)] to get available $unitId
</div>






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




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


<div lang="en" dir="ltr" class="mw-content-ltr">
<br><br>
<br><br>
</div>
Retrieved from "https://help.simplybook.me/index.php?title=User_API_guide/uk"