Налаштування
Налаштуйте цільову адресу та підписки своєї організації через Platform або API.
Кожна організація має одну цільову адресу вебхуків і один активний signing secret (ключ підпису). Налаштуйте їх у Platform або зі свого сервера.
| Відомості | Значення |
|---|---|
| Базовий URL | https://api.sandbox.tapaya.com для пісочниці (sandbox), https://api.tapaya.com для робочого середовища |
| Автентифікація | Server Secret Token у заголовку Authorization. Див. Автентифікація. |
| Область дії | Одна цільова адреса на організацію |
| Пов'язаний посібник | Перевірка й тестування |
Налаштуйте вебхуки в Platform
Відкрийте API Keys для своєї організації і знайдіть Webhooks.
- Введіть свою публічну HTTPS URL-адресу.
- Виберіть потрібні події або ввімкніть Subscribe to all webhook types.
- Увімкніть Enable і натисніть Save.
- Скопіюйте signing secret і збережіть його на своєму сервері.
- Надішліть тестовий вебхук.
Signing secret показується лише один раз
Скопіюйте його, коли створюєте цільову адресу або виконуєте ротацію; пізніше його неможливо отримати. Він лише перевіряє вхідні вебхуки. Ваш Server Secret Token авторизує запити налаштування.
Усі операції
| Операція | Використовуйте, щоб |
|---|---|
| Збереження цільової адреси | Створення або заміна поточної підписки чи ротація її signing secret. |
| Отримання цільової адреси | Отримання поточної URL-адреси, режиму підписки та стану ввімкнення. |
| Видалення цільової адреси | Видалення підписки та її черги й історії доставок. |
Керування цільовою адресою
Правила цільової адреси
Зміна налаштувань
| Коли ви | Що відбувається |
|---|---|
| Змінюєте URL-адресу, події або ключ | Нові події використовують нові налаштування. Події в черзі зберігають стару URL-адресу та ключ, тому підтримуйте обидва робочими, доки черга не спорожніє. |
| Вимикаєте вебхуки | Доставки з черги призупиняються, нові події не фіксуються. Повторне ввімкнення відновлює обробку черги, але пропущені зміни не додаються заднім числом. Тести й далі працюють. |
| Видаляєте цільову адресу | Події в черзі та історія доставок видаляються. Запит, який уже надсилається, усе ще може надійти. Повторне створення генерує новий signing secret. |
Вимоги до URL-адреси
- Публічний HTTPS на порту 443. Localhost і приватні мережі відхиляються, а DNS повторно перевіряється під час кожного підключення.
- Без вбудованих облікових даних, без фрагмента та без переспрямувань.
- Без власних заголовків авторизації. Натомість перевіряйте підпис Tapaya або розмістіть серверний адаптер перед URL-адресою, що вимагає власного ключа.
Помилки
Запити налаштувань завершуються помилкою з такими відповідями. Обробник, який відхиляє або пропускає доставку, є іншою проблемою; див. Обробка помилок.
| Відповідь | Значення |
|---|---|
400 для PUT | Недійсна URL-адреса, непідтримуваний тип події, відсутнє обов'язкове поле або порожній явний вибір подій. |
401 | Server Secret Token відсутній або недійсний. |
404 для GET | Для автентифікованої організації немає цільової адреси. |
Продовжуйте з перевіркою підпису та тестовою доставкою.
Чогось бракує на цій сторінці?Надішліть запит на функцію. Ми додамо цю сторінку, щоб команда бачила контекст.