User API guide/uk: Difference between revisions

<languages/>

{{#seo: |title=Посібник користувача API - SimplyBook.me |description=Використовуйте API користувача SimplyBook.me для створення розширених інтеграцій. Дотримуйтесь нашого посібника для безпроблемного впровадження. Дізнайтеся більше тут! |titlemode=додати |keywords=fAQ, поширені запитання, програмне забезпечення для бронювання, запитання щодо системи бронювання, онлайн-бронювання, програмне забезпечення для календаря, система бронювання, календар бронювання, програмне забезпечення для планування, онлайн-планування зустрічей, онлайн-планування, плагіни, настроювані функції, посилання на настроювану сторінку бронювання, доменне ім'я, настроюване доменне ім'я, настроювана URL-адреса }}

Використовуйте наш API для розробників, щоб створити власний інтерфейс бронювання. Ви можете розробити будь-яке рішення, від найпростішого віджета до багатофункціонального додатка з функціоналом, налаштованим відповідно до специфіки вашого бізнесу.

Перегляньте [https://simplybook.me/api_example/index.html приклад інтерфейсу бронювання на основі API], а також ознайомтеся [https://simplybook.me/api_example/scheduler.js з вихідним кодом] цього рішення.

Для використання методів Simplybook API необхідна автентифікація. Для авторизації в Simplybook API вам потрібно отримати ключ доступу — access-token. Щоб отримати цей access-token, ви повинні викликати метод JSON-RPC getToken на сервісі https://user-api.simplybook.me/login, передавши свій особистий API-ключ. Ви можете скопіювати свій API-ключ в адміністративному інтерфейсі: перейдіть за посиланням «Custom Features» (Налаштування) і виберіть «API Custom Feature» (Налаштування API). Потім потрібно ініціювати віддалений доступ до Simplybook API. Ваш запит повинен містити такі заголовки: «X-Company-Login», «X-Token».

Ви можете використовувати [https://simplybook.me/api_example/json-rpc-client.js бібліотеку javascript JSON-RPC-client] та [https://simplybook.me/api_example/JsonRpcClient.zip бібліотеку php JSON-RPC-client] з наших прикладів для розробки власних рішень.

<br><br>

== '''Авторизація з боку клієнта''' ==

));</nowiki>

<br><br><br>

= '''АВТОРИЗАЦІЯ API КОРИСТУВАЧА/АДМІНІСТРАТОРА ([https://simplybook.me/api/doc#/admin СЛУЖБА АДМІНІСТРУВАННЯ КОМПАНІЇ]''' =

<br><br>

var token = loginClient.getUserToken(YOUR_COMPANY_LOGIN, YOUR_USER_LOGIN, YOUR_USER_PASSWORD);</nowiki>

<br><br>

<br><br>

  <nowiki>this.client = new JSONRpcClient({

});</nowiki>

<br><br>

<br><br>

'''Отримання токен-ключа.'''

)

));</nowiki>

= '''ОТРИМАННЯ ДАНИХ З СЕРВЕРА SIMPLYBOOK''' =

<br><br>

Сторінка бронювання зазвичай є сторінкою, на якій клієнти вибирають необхідну послугу, співробітника та час зустрічі. Потім клієнт вводить контактну інформацію та підтверджує бронювання. Більш складні рішення можуть включати заповнення різних форм, створення групових або багаторазових бронювань тощо. Опишемо робочий процес створення найпростішої сторінки бронювання. Якщо вам потрібно додати додаткові функції на свою сторінку, перегляньте повний список [https://simplybook.me/api/doc методів API Simplybook].

Отже, перше, що ви повинні відобразити, це список послуг та список співробітників. Отримайте ці дані за допомогою методів getEventList та getUnitList. Обидва вони повертають список з повною інформацією про кожен елемент, що міститься в ньому, тому у вас є багато можливостей для відображення послуг та співробітників на вашій сторінці. Щоб здійснити фільтрацію співробітників, використовуйте властивість unit_map списку послуг, яка містить інформацію про співробітників, які можуть надати вибрану послугу.

'''Приклад коду для отримання списку послуг'''

<br><br>

  <nowiki>$services = $client-&gt;getEventList();

//    'id' =&gt; 1, - ідентифікатор послуги

//    'name' =&gt; 'Service 1', - назва послуги

// ), ...)</nowiki>

<br><br>

'''Приклад коду для отримання списку виконавців послуг'''

<br><br>

  <nowiki>$services = $client-&gt;getUnitList();

//    'id' =&gt; 1, - ідентифікатор виконавця

//    'name' =&gt; 'Provider 1', - ім'я виконавця

//    'qty' =&gt; 1, кількість виконавців

// ), ...)</nowiki>

Наступним кроком для клієнта є вибір дати та часу надання послуги. У прикладі використання API ми використовували календар Bootstrap, але ви можете використовувати цей або будь-який інший календар. Щоб встановити першу дату календаря, скористайтеся методом getFirstWorkingDay. Він може приймати ідентифікатор співробітника як параметр і повертає наступну дату, коли вибраний співробітник (або будь-який співробітник компанії за замовчуванням) доступний для бронювання. Щоб показати часові слоти в межах вибраної дати, вам потрібні методи getWorkCalendar і getStartTimeMatrix. Перший метод надає інформацію про початок і кінець робочого дня, а також про вихідні дні. Другий метод повертає список часових слотів, які можна забронювати на певну дату.

  <nowiki>$year = 2015;

//    ...

//);</nowiki>

<br><br>

  <nowiki>$dateFrom = '2015-03-03';

$performerId = 1;

$qty = 1;

//);</nowiki>

<br><br>

  <nowiki>$startDateTime = '2015-03-03 09:00:00';

$serviceId = 1;

$performerId = 1;

</nowiki>

<br><br>

<br><br>

  <nowiki>$additionalFields = array(

);

$clientData = array(

);

Confirm result

';

}</nowiki>

<br><br>

// )), ...)</nowiki>

<br><br>