InnerWeb
Přejít na obsah

Kontrolní seznam převzetí integrace webhook a API v závodě

Převzetí integrace založené na webhookách a API je vhodné opřít o jediný kontrolní seznam, který integrátor a vedoucí IT odškrtnou společně v pilotním provozu. Níže je dvanáct bodů: režim doručování, omezení outboxu, potvrzení doručení, strojový token a kódy odpovědí. Každý bod má komentář, podle kterého poznáte, že je splněn.

89
záznamů v jedné dávce pollera
Zdroj: karta funkcji
300 s
doba rezervace záznamu před návratem do fronty
Zdroj: karta funkcji

Proč převzetí integrace vyžaduje seznam

Integrace webhookem funguje na rozhraní dvou systémů a dvou týmů, takže snadno vznikne situace, kdy každý předpokládá, že druhá strana ověřila kritický prvek. Kontrolní seznam vynucuje, aby každý bod měl vlastníka a důkaz.

V pilotním provozu je náklad chyby nejnižší: provoz je malý a tým výsledky pozorně sleduje. Převzetí integrace po pilotu umožňuje přejít do ostrého provozu s vědomím, která omezení jsou přijatelná a která vyžadují řešení.

Režim doručování a jeho omezení

První rozhodnutí se týká režimu doručování. Nastavení webhook:delivery_mode má dvě hodnoty: direct, výchozí, a outbox. Každá jiná hodnota než outbox znamená direct, takže překlep v nastavení tiše zapne přímý režim. Hodnotu zkontrolujte v panelu a zapište ji do protokolu.

Režim outbox ukládá obsah webhooku do tabulky a externí poller záznamy odebírá a odesílá dál ve stejném datovém obsahu. Vznikl pro instalace, kde síť blokuje odchozí provoz z hostitele aplikace. Má však omezení, která musí převzetí zohlednit.

Omezení, která je třeba přijmout nebo obejít

Outbox nemá limit pokusů, odstup mezi opakováními ani upozornění na uvízlé záznamy. Chybí také úloha, která by tabulku čistila, takže dokončené záznamy neustále přibývají. Neúspěšné potvrzení failed vrátí záznam do stavu pending a zvýší počet pokusů, takže jej poller zkouší znovu bez konce.

Převzetí má zdokumentovat, kdo na straně závodu sleduje uvízlé záznamy a jak tabulka roste. Nejde o vadu k zakrytí, nýbrž o známé omezení, které organizace řeší postupem.

Parametry převzetí režimu outbox

Parametry převzetí režimu outboxGraf: dávka pollera 89 záznamů, rezervace 300 sekund, 6 typů událostí recepce.0100200300početZáznamů v dávce: 89 počet89 početZáznamů v dávceSekundy rezervace: 300 počet300 početSekundy rezervaceTypy událostí recepce: 6 počet6 početTypy událostí recepce
Zdroj: Karty funkcí webhook outbox a událostí recepce

Potvrzení a opakování

Vyzvednutí čekajících záznamů atomicky rezervuje dávku až 89 záznamů pod zápisovým zámkem v transakci, takže dva pollery nepřevezmou tentýž záznam. Záznam ve stavu delivering, jehož rezervace trvá déle než 300 sekund, se vrací do fronty a může být převzat znovu.

Potvrzení doručení přijímá stav delivered nebo failed s volitelným popisem chyby a je idempotentní: potvrzení již doručeného záznamu nic nemění. Převzetí by mělo zahrnovat test, v němž poller odešle totéž potvrzení dvakrát a nic se nezmění.

API a strojový token

Volání API vyžadují strojový token. Převzetí ověřuje, že token je uložen na straně serveru, nikoli v kódu prohlížeče, a že chybějící nebo chybný token vrací odpověď 401. U žádostí o přístup odpověď 201 znamená novou žádost, 200 opakování téhož identifikátoru žádosti a 400 chybná data.

Ověřte také, že opakované volání se stejným identifikátorem nevytvoří duplikát. Je to nejčastější chyba integrací, které v testu fungují jedním voláním, ale v provozu se opakují při absenci odpovědi.

Jak převzetí provést

Převzetí se provádí v jednom sezení s integrátorem a vedoucím IT. Každý bod seznamu končí důkazem: snímkem nastavení, záznamem v kanálu nebo odpovědí s kódem. Chybějící důkaz znamená nesplněný bod.

Nesplněné body se zapisují do krátkého seznamu oprav s termínem a převzetí se považuje za ukončené po jejich uzavření. Seznam spolu s důkazy vstupuje do dokumentace integrace a slouží při auditu.

Kontrolní seznam

Videomateriál

Často kladené otázky

Kdy provést převzetí integrace?

Na konci pilotu, kdy je provoz skutečný a tým má ještě čas na opravy bez produkčního tlaku.

Zaručuje outbox, že se záznam neztratí?

Záznam je uložen v tabulce až do potvrzení, ale nemá limit pokusů ani upozornění na uvízlé záznamy. Proto převzetí vyžaduje postup sledování.

Lze potvrzení odeslat vícekrát?

Ano. Potvrzení již doručeného záznamu je idempotentní a nic nemění.

Proveďte převzetí s naším týmem

Připravíme pro integrátora a oddělení IT protokol o převzetí založený na tomto seznamu. Domluvte si konzultaci s firmou InnerWeb.

Pojďme si promluvit