InnerWeb
Přejít na obsah

Specifikace integrace pro dodavatele KD: průvodce krok za krokem

Nasazení webhooku čipnutí karty proběhne v jediné iteraci jen tehdy, když dodavatel KD dostane na začátku úplnou specifikaci. Chybějící pole nebo neznámé omezení vede k dalšímu kolu testů. Níže popisujeme šest kroků od ověření až po akceptační testy, vycházíme z integračního dokumentu předávaného dodavatelům KD.

6
kroků specifikace pro jednu iteraci
Zdroj: průvodce InnerWeb
2 000+
čipnutí denně v závodě s agenturami
Zdroj: objem provozu v závodě

Krok 1: popište cíl a hranice odpovědnosti

Specifikaci začněte jednou větou o cíli: systém KD posílá do InnerWeb HTTP POST požadavek při každém čipnutí karty a InnerWeb jej využívá ke kontrole školení, povolení a evidenci docházky. Hranici jasně zapište: InnerWeb pro tuto integraci nedodává vlastní čtečky a nevyměňuje čtečky, takže veškerá práce dodavatele KD spočívá v konfiguraci odesílání událostí. Podrobná specifikace integrace existuje jako dokument PDF předávaný externímu dodavateli; tento průvodce popisuje, jak ji uspořádat.

Krok 2: ověření a relace

Volání vyžaduje token získaný z přihlašovacího endpointu API. Token má omezenou dobu platnosti a integrace ho obnovuje automaticky, proto musí specifikace od dodavatele vyžadovat obnovu tokenu s rezervou a opětovné přihlášení po odmítnutí autorizace. Zapište také požadavek na technický účet určený výhradně pro integraci a zákaz ukládání hesel a tokenů do logů.

Čísla ze specifikace

Čísla ze specifikaceSloupcový graf: šest kroků specifikace, dvě povinná pole, nula čteček k výměně.0246početKroků specifikaceKroků specifikace: 6 počet6Povinných políPovinných polí: 2 počet2Čteček k výměněČteček k výměně: 0 počet0
Zdroj: Průvodce InnerWeb

Krok 3: pole hlášení

Vypište pole pod sebou a označte, která jsou povinná. Hlášení obsahuje čas události, místo čipnutí a údaje o osobě: jméno a příjmení (povinné), zkratku, firmu (název povinný), číslo aktivní karty, telefon, e-mail a jazyk. Číslo aktivní karty je identifikátor, který spojuje čipnutí s účtem osoby, a externí firma se přiřazuje podle názvu firmy. Vyžádejte proto jednotný zápis názvů firem.

  • Povinné: jméno a příjmení, název firmy.
  • Klíč pro přiřazení: číslo aktivní karty.
  • Místo: pole actionPlace rozlišující umístění čteček.
  • Volitelné: zkratka, telefon, e-mail, jazyk.

Krok 4: požadavky na událost a odesílání

Dva požadavky musí být ve specifikaci jednoznačné. Za prvé, systém KD odesílá události v reálném čase, s časem události načteným z čtečky, a po výpadku spojení si události zachovávají svůj původní čas. Za druhé, každá událost nese směr (vstup nebo výstup) a identifikátor události a InnerWeb je přijímá přes ověřený webhook. Pravidla párování vstupů a výstupů a odmítání duplicit se určují ve specifikaci s dodavatelem KD a popisují se jako dohodnutý rozsah prací.

Doplňte požadavek na odolnost vůči sériím a opakováním: v závodě s více agenturami může provoz přesáhnout 2 000 čipnutí za pracovní den.

Krok 5: místa čipnutí a šablony

Požádejte dodavatele o seznam čteček s názvy míst čipnutí ve tvaru, v jakém budou předány do pole actionPlace. Události z místa bez šablony v InnerWeb skončí v logu a nespustí školicí kontrolu, proto musí být seznam čteček dohodnut s konfigurací na straně InnerWeb ještě před zahájením testů. Vynechaná čtečka je nejčastější příčinou čipnutí viditelných v logu, ale bez dopadu na bránu.

Krok 6: akceptační testy

Popište testovací scénáře, nikoli obecnou formulaci o testech. Minimum: čipnutí známé osoby, čipnutí neznámé osoby, opakované čipnutí v krátkém odstupu, čipnutí na každé čtečce ze seznamu, vypršení tokenu během odesílání a série událostí. Kritérium uzavření: každý scénář má očekávaný výsledek na straně InnerWeb. Pamatujte, že samotný webhook bez mapování na vstupy nedává docházku, proto zahrňte test viditelnosti čipnutí v registru vstupů.

Kontrolní seznam

Videomateriál

Často kladené otázky

Musí dodavatel KD vyměnit čtečky?

Ne. Integrace spočívá v konfiguraci odesílání události čipnutí, InnerWeb čtečky nedodává ani nevyměňuje.

Proč specifikace vyžaduje odesílání v reálném čase?

Protože má být zachován čas události z čtečky a opožděné odesílání ztěžuje párování vstupů a výstupů i kontrolu přítomnosti.

Kdo určuje směr vstupu a výstupu?

Systém KD předává směr v každé události a pravidla párování vstupů a výstupů se určují ve specifikaci s dodavatelem KD.

Zdroje

Předáme specifikaci vašemu dodavateli KD

Máme připravený integrační dokument pro dodavatele KD. Domluvte si schůzku se týmem InnerWeb a uzavřete nasazení v jediné iteraci.

Pojďme si promluvit