SelSup Developers

Асноўны працоўны паток · Кіраўнікі

Вэб-хакі і інтэграцыя на падставе падзей

Выхадная ўстаноўка webhook, бяспечны прыёмнік, абарона дублікатаў, і аднаўленне прапушчаных падзей праз API.

5 раздзелыКіраўніцтва распрацоўшчыкам
→

Веб-хакі зніжаюць адтэрміноўку змен, але не замяняюць крыніцу праўды.

Інтэграцыі на падставе падзей і паслугі па заканчэнні

01

Дэфіцытуе падзеі і ўласнасць

Пачніце з аднаго дзелавога падзея, напрыклад, новы або зменены заказ, змены запасаў або змены коштаў.

Падтрымлівайце арыгінальную карыснасць вэб-хака асобна ад нармалізаванай мадэлі на абмежаваны перыяд.

Новае варыянтнае поле не павінна парушаць аналіз вядомай структуры падзеі.

Сродкі API канечныя пункты

POST/api/webhook/Стварэнне вэб-хакаGET/api/webhook/Устаноўкі вэб-хаука

02

Стварэнне бяспечнага прыёмніка HTTP

  1. 1

    Забарона патрабавання

    Прымаць толькі неабходныя метады і тыпы кантэнту, прымяніць мяжу памеру цела, і выкарыстоўваць кароткі час чытання.

  2. 2

    Праверка крыніцы

    Выкарыстоўвайце сакрэт у нелістаўлены URL або канфігурацыйнага загалоўку і дадайце фільтраванне API-gateway. Не давяраеце толькі карыстальніку-агенту.

  3. 3

    Працягвайце падзею

    Захоўваць карысную нагрузку і ключ дэдуплікацыі ў адной транзакцыі, а затым вярнуць паспяховы адказ хутка.

  4. 4

    Працэс асіхронна

    Званкі ERP, WMS і іншых сістэм з чаргі замест прыязджанага HTTP запыту.

!
Падтрымлівайце шлях адказу кароткі

Павольны адказ павялічвае час і рызыку падвойнага дастаўкі.

Мінімальны ўзор прыёмніка · JavaScript
app.post('/selsup/events/secret-path', async (request, response) => {
  const eventKey = createStableEventKey(request.body);
  const inserted = await inbox.insertOnce(eventKey, request.body);
  response.sendStatus(inserted ? 202 : 200);
});

03

Дублікаты, заказ і дэдуплікацыя

Зрабіце падраздзяленне дубляжа, як звычайна. Выкарыстоўвайце стабільны ідэнтыфікатар падзеі, калі ён прысутнічае; інакш вывесці ключ з тыпу суб'екта, ID суб'ект, час мадыфікацыі і хэш значных дадзеных.

Падзеі могуць прыйсці непарадкавана. Параўноўвайце зменены Дата перад напісаннем або перазагрузіць бягучую суб'ект праз API.

Вярнуць статус поспеху для падзеі, якая ўжо апрацавана. У адваротным выпадку адправіцель можа працягваць перапрабаваць завершаную працу.

i
Узору ў паштовай скрыні

Тэбліца паступных падзей з унікальным ключом падзеі, статусам і лікам спробы спрашчае дэдуплікацыю, паўторную гульню і аўдытацыю.

04

Здабыць прапушчаныя падзеі

Выконваць перыядычную API пагадненне нават калі вэб-хакі здаровыя. Выкарыстоўвайце мадыфікавануюДата з перакладам для заказов і склад або зменены-SKU праверка для запасаў.

Пасля выключэння прыёмніка, выцягнуць паштовую скрынку і папрасіць змены для поўнага выключэнні вокны.

Сродкі API канечныя пункты

GET/api/order/findЗдабыць змены ў парадкуGET/api/wms/stock/findЗгадненне змены запасаў

05

Кіраванне жыццёвым цыклам webhook

Выкласці актыўны URL, тып падзеі, апошні паспяховае атрыманне, і апошні error ў вашай інтэграцыі. Гэта дазваляе дыягнастыку без прамога доступу да сервера-лога.

Перад заменкай або выдаленнем URL, пераканацца, што новы прыёмнік прымае падзеі. Адмяніць старую таямніцу пасля пераезду.

Сродкі API канечныя пункты

GET/api/webhook/Праверка канфігураваных вэб-хокаўDELETE/api/webhook/{webhookId}Знішчыць вэб-хаук