Partner API: управление на ключове и webhooks
С Partner API свързваш собствени страници за резервации, приложения и интеграции със STRYK. Създаваш ключове точно с нужните права и настройваш webhooks.
Contents
Преди да започнеш
- Трябва ти правото Управление на канали. Само с него виждаш реда API на страницата Канали.
- Изясни кои области интеграцията трябва да чете или да записва. Ключът получава само тези права.
- Интеграцията извиква Partner API от своя сървър. Ключа никога не поставяй в код за браузъра или в приложение. Крайните точки, параметрите и примерите са в Документация за разработчици. Там разделът Удостоверяване и обхвати обяснява какво позволява всяко право.
- Webhook-ите изискват получател с адрес, който започва с https://.
Отваряне на API
In STRYKКанали
- Избери в Собствени връзки реда API с добавката „API ключове и webhooks“. Диалогът API се отваря.
- Избери раздела API ключове или Webhooks. С Документация за разработчици в заглавието на диалога отваряш портала за разработчици.
- Раздели API ключове и Webhooks
- Ключове с права
- Действия за ключа
Създаване на API ключ
In STRYKКаналиAPIAPI ключове
- Избери Създаване на API ключ. Диалогът Създаване на API ключ се отваря.
- Въведи Име, например „Страница за резервации“.
- Избери при Права шаблон: Само четене (чете всички области), Четене и запис (записва там, където е възможно) или По поръчка. При По поръчка избираш за всяка област Без достъп, Четене или Запис. Областите са Хотел и стаи, Наличност, Цени и тарифи, Резервации, Гости, Плащания и Фактури. Запис включва Четене. Фактурите са фискални документи на хотела и през API могат само да се четат.
- По желание: отвори Разширено. Избери при Изтичане: Без срок, 30 дни, 90 дни, 1 година или Дата (от утре, най-много три години напред). Въведи при IP ограничение на всеки ред адрес или CIDR мрежа, най-много 20. Ако е празно, са разрешени всички адреси. В Бележка записваш вътрешна бележка.
- Избери Създавай. STRYK показва API ключът е създаден с ключа и бележката Видимо само сега.
- Копирай ключа и го запази например в мениджър на пароли. Избери Готово.
Управление на ключове
In STRYKКаналиAPIAPI ключове
Списъкът показва за всеки ключ Име, началото на ключа, Права, Създаден, Последно използван, Изтичане и статуса: Активен, Изтича скоро, Отменено или Изтекъл. Избери ключ, за да видиш Права, Изтичане, Разрешени IP адреси, Лимит на заявките (заявки в минута), Използване, Последни заявки и История.
- Отвори в реда менюто Опции.
- Избери Генериране наново, ако интеграцията трябва да получи нов ключ със същите права. Избери при Текущ ключ Старият ключ е валиден още 24 ч, за да превключиш интеграцията, или Отмени веднага. Потвърди с Генериране наново. STRYK показва новия ключ веднъж.
- Избери Отмени и потвърди Да се отмени ли API ключът?, за да блокираш ключ веднага. Заявки с този ключ STRYK тогава отхвърля.
Настройка на webhooks
In STRYKКаналиAPIWebhooks
Webhook изпраща избраните събития подписани по HTTPS към твоите системи.
- Избери Създай уебхук. Диалогът Нов уебхук се отваря.
- Въведи URL на получателя, например https://crm.nordlicht.invalid/hooks/stryk. Адресът трябва да започва с https://.
- По желание: въведи Описание, например „Резервации към нашата CRM система“.
- Избери при Събития поне едно от: Резервацията е създадена, Резервацията е променена, Резервацията е отменена, Гостът е променен, Наличността е променена, Цената е променена, Плащането е променено или Статусът на стаята е променен. С Избери всички и Изчисти избора избираш всички или никое.
- Избери Създай уебхук. STRYK показва Твоята тайна за подписване веднъж.
- Запиши тайната в получателя. Как получателят проверява подписа, описва Webhooks и проверка на подписа в документацията за разработчици.
- Избери webhook-а и после Изпрати тестово събитие. STRYK съобщава „Тестовото събитие се доставя.“
Управление на webhooks
Ort: Канали > API > Webhooks, избери webhook
- С превключвателя Доставката е активна паузираш или активираш webhook-а. Паузираните webhook-и не получават събития. След активиране доставката започва с новите събития.
- Последните 7 дни, Последен успех и Последна грешка показват състоянието. При Доставки виждаш всяка доставка с HTTP статус и Опити. С Изпрати отново повтаряш доставка.
- Поднови тайната създава нова тайна. Досегашната остава валидна още 24 часа, за да превключиш получателя.
- С Редактиране променяш адреса и събитията, с Изтриване и потвърждението Да се изтрие ли уебхукът? го премахваш. Протоколът за доставките се пази 30 дни.
Как проверяваш резултата
- При ключа Последно използван стои дата, щом интеграцията го използва. Заявки 24 ч показва броя заявки.
- При webhook-а Последните 7 дни показва „{Zahl} доставени, {Zahl} неуспешни“, а тестовото събитие стои при Доставки.
Ако нещо не работи
| Какво виждаш | Причина | Как да го решиш |
|---|---|---|
| „Избери поне едно право.“ | Нито една област няма право. | Избери шаблон или дай на поне една област Четене или Запис. |
| „Моля, въведи име.“ | Липсва Име. | Въведи име. |
| „Моля, провери:“ с адрес | Адрес в IP ограничение е невалиден. | Поправи адреса или CIDR мрежата. Разрешени са най-много 20 записа. |
| „Моля, избери дата от утре, най-много три години напред.“ | Датата на изтичане е извън допустимия период. | Избери дата от утре, която е най-много три години напред. |
| „Адресът трябва да започва с https://.“ | URL на получателя не е HTTPS адрес. | Въведи адрес с https://. |
| „Избери поне едно събитие.“ | Webhook-ът няма събитие. | Избери поне едно при Събития. |
| Спрян поради повтарящи се грешки | Получателят не отговаря със статус 2xx. | Провери дали получателят е достъпен и избери Активирай отново. |
| „Активирай webhook-а, за да изпратиш тестово събитие.“ | Webhook-ът е паузиран. | Активирай Доставката е активна и изпрати тестовото събитие. |
| „Списъкът не можа да се зареди. Затвори и отвори отново.“ | Списъкът с права и събития не е зареден. | Затвори диалога и го отвори отново. |