Використання API Passtastic
Що дає вам API
API Passtastic підключає ваші власні системи — індивідуальну POS-систему, CRM, внутрішній застосунок — безпосередньо до вашої програми лояльності. За його допомогою ви можете:
- Реєструвати клієнтів і видавати картки wallet зі свого власного процесу реєстрації
- Додавати штампи чи бали та перевіряти баланс клієнта зі своєї каси чи бек-офісу
- Отримувати сповіщення в реальному часі за допомогою вебхуків — замість постійних запитів до API, Passtastic одразу надсилає подію у вашу систему в момент, коли щось відбувається (клієнт реєструється, нагороду використано, і не тільки)
Це рішення для бізнесів, які створюють індивідуальну інтеграцію. Якщо вам потрібне просто готове підключення, перегляньте Підключіть Square POS або POS-системи та інтеграції — без написання коду.
Доступ до API залежить від вашого плану. Якщо він не включений, під час відкриття API та вебхуки в Налаштуваннях ви побачите пропозицію оновити план.
Створіть API-ключ
1. Відкрийте Налаштування, потім API та вебхуки (у розділі Бізнес).
2. На вкладці API-ключі натисніть Створити ключ.
3. Вкажіть назву ключа, щоб пізніше знати, для чого він (напр. «продакшн CRM»).
4. Ваш новий ключ буде показано один раз, у вікні Ваш новий API-ключ. Скопіюйте його зараз — повторно побачити його буде неможливо. Натисніть Скопіювати або Показати, щоб спершу переглянути його.
Ставтеся до цього ключа як до пароля. Будь-хто, хто його має, може діяти від імені вашого акаунта через API.
5. Зберігайте ключ у безпечному місці у своїй системі (змінна середовища, менеджер секретів) і надсилайте його як заголовок автентифікації з кожним запитом — точний формат наведено в технічній документації нижче.
Створювати або відкликати API-ключі можуть лише адміністратори.
Загубили ключ або підозрюєте витік?
Ключі повторно не показуються після створення. Якщо ви загубили ключ або підозрюєте, що він став відомий стороннім, відкрийте API-ключі та натисніть біля нього Відкликати — це одразу зупинить його дію — а потім створіть новий і оновіть свою інтеграцію.
Налаштуйте вебхук
Вебхуки дозволяють вашій системі реагувати в момент, коли щось відбувається у Passtastic, без потреби постійно опитувати API.
1. На вкладці Вебхуки натисніть Додати ендпоінт.
2. Введіть URL ендпоінту — адресу у вашій власній системі, яка отримає подію (напр. `https://ваша-система.com/hook`).
3. У розділі Події оберіть, які події отримувати:
- Клієнта зареєстровано
- Баланс оновлено
- Рівень змінено
- Нагороду використано
4. Збережіть. Ваш секрет підпису буде показано один раз, у вікні Секрет підпису — скопіюйте його зараз. Використовуйте його, щоб перевірити, що запит вебхука дійсно надійшов від Passtastic (технічна документація пояснює, як перевірити підпис).
Створювати або редагувати вебхуки можуть лише адміністратори.
Кожен ендпоінт вебхука показує свої останні доставки, тож ви можете перевірити, чи виклик пройшов успішно, чи ні, і повторити невдалу доставку, щойно ваша система знову запрацює, не чекаючи наступної події.
Редагування або вимкнення вебхука
Відкрийте ендпоінт і натисніть Редагувати, щоб змінити URL або події, або встановіть статус Вимкнено, щоб призупинити доставки, не видаляючи його. Натисніть Видалити, щоб прибрати його остаточно.
Де знайти повну технічну документацію
Цей посібник охоплює частину роботи в панелі — створення ключів і вебхуків. Ендпоінти, формати запитів/відповідей, заголовки автентифікації, коди помилок і приклади коду шукайте в повній документації API. Ви також можете відкрити її будь-коли за посиланням Читати документацію API вгорі сторінки API та вебхуки.