Іноді хтось хоче щось під’єднати до Stippa. Розробник сайту, який хоче відтворити форму бронювання у вашому фірмовому стилі, бухгалтер зі скриптом, що забирає дохід, або сервіс на кшталт Zapier, що надсилає повідомлення, щойно надійде новий запис. Така людина попросить у вас ключ API.
Ця сторінка для вас, а не для розробника. Щоб ухвалити правильне рішення, не треба знати, як це влаштовано технічно. Те, що потрібно розробнику, є в документації для розробників, англійською.
Що таке ключ API?
Довгий таємний текст, що починається на stp_live_. Хто його має, може від імені вашої справи
робити саме те, що позначено під час створення ключа, і нічого більше.
Три речі важливіші за техніку:
- Ключ належить вашій справі. Він ніколи не дістанеться до даних іншої справи, навіть випадково.
- Ключ - це не вхід у систему. До нього не прив’язано пароля, і ніхто не зайде з ним у застосунок. Він працює лише для самої інтеграції.
- Ключ - це таємниця, як ключ від приміщення. Хто його має, той може ним скористатися. Саме тому існує решта цієї сторінки.
Коли він потрібен?
Лише тоді, коли хтось про нього просить. Для звичайного користування Stippa ключ API не потрібен ніколи: віджет бронювання, календар, листи й публічний профіль працюють без нього.
Типові випадки, коли він таки потрібен:
- Розробник вашого сайту хоче повністю вбудувати бронювання у ваш сайт, замість стандартного віджета.
- Хтось хоче автоматично переносити ваші записи в таблицю чи бухгалтерську програму.
- Ви хочете сповіщення у Slack, Teams чи Zapier, щойно хтось забронює.
Яка підписка потрібна?
| Що ви хочете | Від |
|---|---|
| Читати дані (записи, клієнти, послуги, доступність) | Groei |
| Створювати й змінювати дані, а також вебхуки | Pro |
Якщо перейти на нижчу підписку, ключ залишиться. Перестануть діяти лише ті права, яких ваша підписка більше не дає. Коли пізніше повернетеся вище, інтеграція одразу знову працює й нікому нічого налаштовувати не треба.
Як створити ключ
Ключі є в застосунку Dev, який з’являється в перемикачі застосунків угорі ліворуч, щойно ви ввімкнете модуль API access.
Увімкніть модуль
Перейдіть до Управління > Модулі й увімкніть API access. Застосунок Dev після цього з’явиться в перемикачі застосунків.
Перейдіть до Dev > Ключі
Натисніть Новий ключ.
Дайте назву, яку зрозумієте й за рік
Не «тест» і не «ключ 2», а «Сайт Jansen Webdesign» або «Інтеграція з бухгалтерією». Коли колись доведеться щось відкликати, назва - єдине, за чим видно, чий це ключ.
Позначте лише те, що потрібно
Є готові набори. Якщо сумніваєтеся, виберіть Лише читання: такий ключ нічого не змінить. Права додати потім не вийде, зате вийде створити другий ключ, і це безпечний порядок.
Скопіюйте ключ одразу
Повний ключ видно один раз, зразу після створення. Далі Stippa зберігає лише зашифровану форму, і ми теж його не покажемо. Якщо загубите, відкличте його й створіть новий.
Як безпечно передати ключ
Надіслати ключ раз поштою й забути - найпоширеніший спосіб усе зіпсувати: поштова скринька роками лишається доступною для пошуку, її ділять з іншими, і вона переїжджає до наступного роботодавця.
- Передайте його каналом, що стирає повідомлення, або через менеджер паролів, яким розробник і так користується.
- Ніколи не вставляйте його в публічне повідомлення, тікет чи спільний документ.
- Створюйте окремий ключ для кожної сторони. Дві компанії з одним ключем означають, що, відкликаючи один, ви ламаєте інтеграцію обох.
- Попросіть дату завершення, коли робота тимчасова. Ключ може закінчитися сам, і нікому не доведеться пам’ятати про це потім.
Як відкликати ключ
Перейдіть до Dev > Ключі й виберіть Відкликати біля потрібного ключа. Це діє негайно: найближчий запит із цим ключем буде відхилено. Відкликання скасувати не вийде, тож інтеграція має отримати новий ключ.
Відкликайте принаймні тоді:
- коли співпраця з розробником чи агенцією завершується;
- коли ключ потрапив туди, куди не мав;
- коли ви більше не знаєте, для чого ключ. Ключ, який ніхто не може впізнати, не має бути активним.
Не певні, чи ключ ще використовується? Загляньте спершу в Dev > Журнал. Там видно для кожного запиту, коли він надійшов і чи вдався. Ключ, якого там немає вже місяцями, можна спокійно відкликати.
Вебхуки: у зворотний бік
Ключ дозволяє комусь забирати дані у вас. Вебхук робить навпаки: Stippa надсилає повідомлення на вказану вебадресу, щойно щось стається, наприклад коли запис бронюють або скасовують. Саме це потрібно інтеграції зі Slack чи Zapier. Вебхуки є в підписці Pro і живуть у Dev > Вебхуки.
Адреса вебхука заслуговує тієї самої обережності, що й ключ. За кожної події Stippa надсилає на цю адресу пов’язані дані, зокрема імена, адреси пошти й номери телефонів ваших клієнтів. Отже, хто може задати адресу, той може спрямувати цей потік деінде. Беріть адресу лише від того, кому довіряєте, і перегляньте список, коли вже не пам’ятаєте, хто що налаштував.
Якщо адреса лишається недоступною, Stippa пробує ще кілька разів, а потім сама вимикає endpoint, щоб не слати нескінченно на мертву адресу. Це видно як повідомлення над списком, із кнопкою, щоб увімкнути знову, коли одержувач запрацює.
Часті питання
Чи зайде хтось із моїм ключем у Stippa? Ні. Ключ працює лише для інтеграції й не дає доступу до застосунку, вашого акаунта чи підписки.
Чи дістанеться ключ до даних іншої справи? Ні. Ключ сам визначає, про яку справу йдеться; налаштування, яким можна було б вказати іншу, немає.
Не бачу застосунку Dev. Модуль API access вимкнено, ваша підписка - Starter, або у вас роль співробітника. Застосунок видно власникам і адміністраторам.
Мій розробник просить документацію. Надішліть його до документації для розробників. Вона англійською й містить усе потрібне, разом із прикладами.