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