Скокни до содржината
Task, Channels and Partner API

Partner API: управување со клучеви и вебхуци

Со Partner API ги поврзуваш своите страници за резервации, апликации и интеграции со STRYK. Создаваш клучеви со точно потребните права и поставуваш вебхуци.

Last updated: Owner, Developers
Contents
  1. Пред да започнеш
  2. Отвори API
  3. Создај API клуч
  4. Управувај со клучеви
  5. Постави вебхуци
  6. Управувај со вебхуци
  7. Како го проверуваш резултатот
  8. Ако нешто не функционира
  9. Ова е поврзано со

Пред да започнеш

  • Ти треба правото Управување со канали. Само со него ја гледаш линијата API на страницата Канали.
  • Разјасни кои области интеграцијата мора да ги чита или пишува. Клучот добива само тие права.
  • Интеграцијата го повикува Partner API од својот сервер. Клучот никогаш не го ставаш во код за прелистувач или во апликација. Крајните точки, параметрите и примерите ги наоѓаш во Документација за програмери. Таму делот Автентикација и опсези објаснува што дозволува секое право.
  • Вебхуците бараат примач со адреса што започнува со https://.

Отвори API

In STRYKКанали

  1. Избери под Сопствени поврзувања линијата API со додатокот „API клучеви и вебхуци“. Се отвора дијалогот API.
  2. Избери го табот API клучеви или Вебхуци. Со Документација за програмери во заглавието на дијалогот го отвораш порталот за програмери.
  1. Табови API клучеви и вебхуци
  2. Клучеви со права
  3. Дејства на клучот

Создај API клуч

In STRYKКаналиAPIAPI клучеви

  1. Избери Создај API клуч. Се отвора дијалогот Создај API клуч.
  2. Внеси Име, на пример „Страница за резервации“.
  3. Кај Права избери шаблон: Само читање (читање на сите области), Читање и пишување (пишување каде е можно) или Прилагодено. Кај Прилагодено за секоја област избираш Без пристап, Читање или Пишување. Областите се Хотел и соби, Достапност, Цени и тарифи, Резервации, Гости, Плаќања и Фактури. Пишување го вклучува Читање. Фактурите се фискални документи на хотелот и преку API може само да се читаат.
  4. Опционално: отвори Напредно. Избери Истекување: Без истекување, 30 дена, 90 дена, 1 година или Датум (од утре, најмногу три години однапред). Под IP ограничување внеси по ред адреса или CIDR мрежа, најмногу 20. Празно дозволува сите адреси. Под Белешка чуваш внатрешна забелешка.
  5. Избери Создај. STRYK прикажува API клучот е создаден со клучот и напомената Видливо само сега.
  6. Копирај го клучот и зачувај го, на пример, во менаџерот на лозинки. Избери Готово.

Управувај со клучеви

In STRYKКаналиAPIAPI клучеви

Списокот прикажува по клуч Име, почетокот на клучот, Права, Креирана, Последно користено, Истекување и статусот: Активно, Наскоро истекува, Повлечен или Истечен. Избери клуч за да ги видиш Права, Истекување, Дозволени IP адреси, Лимит на барања (барања на минута), Употреба, Последни барања и Историја.

  1. Во линијата отвори го менито Опции.
  2. Избери Регенерирај, ако интеграцијата треба да добие нов клуч со истите права. Кај Досегашен клуч избери Стариот клуч уште 24 ч важи за да ја пренесеш интеграцијата, или Повлечи веднаш. Потврди со Регенерирај. STRYK новиот клуч го прикажува еднаш.
  3. Избери Повлечи и потврди Да се повлече API клучот?, за веднаш да го блокираш клучот. Барањата со овој клуч STRYK ги одбива.

Постави вебхуци

In STRYKКаналиAPIВебхуци

Вебхукот ги испраќа избраните настани потпишани преку HTTPS до твоите системи.

  1. Избери Создај вебхук. Се отвора дијалогот Нов вебхук.
  2. Внеси URL на примач, на пример https://crm.nordlicht.invalid/hooks/stryk. Адресата мора да почнува со https://.
  3. Опционално: внеси Опис, на пример „Резервации до нашиот CRM“.
  4. Избери под Настани најмалку еден: Резервација е создадена, Резервацијата е изменета, Резервацијата е откажана, Гостин е променет, Достапноста е променета, Цената е променета, Плаќањето е променето или Статусот на соба е променет. Со Избери ги сите и Поништи избор избираш сите или ниедан.
  5. Избери Создај вебхук. STRYK прикажува Твојата тајна за потпишување еднаш.
  6. Тајната внеси ја во својот примач. Како примачот ја проверува потписот, опишува документацијата за програмери во Вебхуци и проверка на потпис.
  7. Избери го вебхукот и потоа Испрати тестен настан. STRYK јавува „Тестен настан се испорачува.“

Управувај со вебхуци

Ort: Канали > API > Webhooks, избери webhook

  • Со прекинувачот Испораката е активна паузираш или активираш вебхукот. Паузираните вебхуци не добиваат настани. По активирањето испораката почнува со нови настани.
  • Последни 7 дена, Последен успех и Последна грешка ја прикажуваат состојбата. Под Испораки ја гледаш секоја испорака со HTTP статус и Обиди. Со Испрати повторно ја повторуваш испораката.
  • Обнови тајна создава нова тајна. Досегашната важи уште 24 часа, за да можеш да го пренесеш примачот.
  • Со Уреди ја менуваш адресата и настаните, со Избриши и потврдата Да се избрише вебхукот? го отстрануваш. Протоколот за испораки останува 30 дена.

Како го проверуваш резултатот

  • Кај клучот стои Последно користено со датум, штом интеграцијата го користи. Барања 24 ч ги брои барањата.
  • Кај webhook-от Последни 7 дена стои „{Zahl} испратени, {Zahl} неуспешни“, а тест-настанот е под Испораки.

Ако нешто не функционира

Што гледашПричинаКако да го решиш
„Избери најмалку едно право.“Ниедна област нема право.Избери шаблон или дај на најмалку една област Читање или Пишување.
„Внеси име.“Име недостасува.Внеси име.
„Провери:“ со адресатаЕдна адреса во IP ограничување е неважечка.Поправи ја адресата или CIDR мрежата. Дозволени се најмногу 20 записи.
„Избери датум од утре, најдолго три години однапред.“Датумот на истекување е надвор од дозволениот период.Избери датум од утре, кој е најмногу три години однапред.
„Адресата мора да почнува со https://.“URL на примач не е HTTPS адреса.Внеси адреса со https://.
„Избери најмалку еден настан.“Вебхукот нема ниеден настан.Избери под Настани најмалку еден.
Паузирано поради повторени грешкиПримачот не одговара со статус 2xx.Провери дали примачот е достапен и избери Повторно активирај.
„Активирај го вебхукот за да испратиш тестен настан.“Вебхукот е паузиран.Активирај Испораката е активна и испрати го тестниот настан.
„Изборот не можеше да се вчита. Затвори го и отвори го повторно.“Списокот со права и настани не е вчитан.Затвори го дијалогот и повторно отвори го.
Контакт