CMS és API

Webhookok és kötegelt feldolgozás.

Válassza ki a szinkron, webhook vagy kötegelt kézbesítést a mennyiség, a várakozási idő, az újrapróbálkozás és a működési tulajdonjog közül.

Tisztázza a feladatot és a döntést

Ez az útmutató a webhookokat és a kötegelt feldolgozást áttekinthető működési munkafolyamattá alakítja. Összeköti a tartományi döntéseket, a tulajdonjogot, a bizonyítékokat és az elfogadást, így az eredmény továbbra is működik a termelésben.

Válassza ki a szinkron, webhook vagy kötegelt kézbesítést a mennyiség, a várakozási idő, az újrapróbálkozás és a működési tulajdonjog közül.

Gyakorlati munkafolyamat

  1. 1

    A készletforrás típusai, azonosítói, mezői, területei, tulajdonosai és közzétételi állapotai.

  2. 2

    Válassza ki a kézbesítési mintát a mennyiség, a várakozási idő, a szerkesztői vezérlés és a hibatűrés közül.

  3. 3

    A forrásrekord hozzárendelése egy különálló nyelvi verziójú rekordhoz tartós csatolással.

  4. 4

    Adjon hozzá hitelesítést, idempotenciát, újrapróbálkozást, gyorsítótár érvénytelenítését, naplózást és hozzáférés-vezérlést.

  5. 5

    Tesztközzététel, forrásmódosítások, nem elérhető eredmények, visszaállítás, billentyűzetkezelés és figyelés a kiadás előtt.

Példa vagy eszköz

Az életciklus-diagram az újrapróbálkozások, az idempotencia, a figyelés és az újrajátszás megvalósítási szerződésévé válik. Az eszközben rögzítse az alapállapotot, a tulajdonost, a döntést, a bizonyítékot, a nyitott kiadást és a jóváhagyás dátumát is. Valódi oldalt vagy tranzakciót használjon, hogy a csapat láthassa a függőségeket, a kivételeket és a kiadást követő karbantartási munkát.

Döntési pontRekordElfogadási kritérium
AlapvonalMegfigyelt jelenlegi állapotA felvétel forrása és dátuma
DöntésA kiválasztott lehetőség és indoklásFigyelembe vették a kockázatot és a közönséget
BizonyítékTeszteljen, dokumentáljon vagy mérjenÁttekinthető és verzióspecifikus
JóváhagyásNév, szerep és dátumMinden kötelező kritérium teljesült

Válasszon kézbesítést a várakozási idő, a mennyiség és a tulajdonjog közül

Használjon szinkron kézbesítést a kis interaktív kérésekhez, amelyek általában az interfész időtúllépésén belül fejeződnek be, és azonnal jelenthetik az eredményt. Használjon webhookot, ha a munka aszinkron, de minden eredménynek azonnal meg kell jelennie a CMS-ben, amint készen áll. Használja a kötegelt feldolgozást nagy ütemezett gyűjtésekhez, ellenőrzött importokhoz vagy migrációkhoz, ahol az átviteli sebesség és a reprodukálhatóság fontosabb, mint az azonnali kézbesítés. A minták együtt is létezhetnek, de minden tartalomosztálynak rendelkeznie kell egy dokumentált alapértelmezett értékkel.

Becsülje meg a napi és csúcsmennyiséget, a cikk méretét, az elfogadható befejezési időt, az újrapróbálkozási időszakot, a rendelési igényt, a felülvizsgálói kapacitást és az operatív tulajdonost. A gyors eredménynek nincs értéke, ha a szerkesztői sor nem tudja feldolgozni. Tartalmazzon upstream és downstream korlátokat: CMS export, API sebesség, várólista dolgozók, visszahívási végpont, adatbázis írások, gyorsítótár érvénytelenítése és ellenőrzési munkaterhelés. Válassza ki a legegyszerűbb mintát, amely megfelel a teljes szolgáltatási célnak.

MintaHasználja mikorAlapvető ellenőrzés
SzinkronKis kérés és rövid korlátos késleltetésIdőtúllépés biztonságos ügyfél-újrapróbálkozással
WebhookA független munkáknak azonnal meg kell érkezniükAláírás-ellenőrzés és idempotens eseménykezelés
BatchNagy vezérelt készlet és ütemezett befejezésManifest, ellenőrzőpont, egyeztetés és újrajátszás

Valósítson meg egy ellenőrizhető webhook életciklust

Csak a HTTPS POST elfogadása, az aláírás ellenőrzése a nyers törzshöz képest, ellenőrizze az időbélyeg-tűrést, és utasítsa el a nem támogatott eseményverziókat. Az üzleti változtatások alkalmazása előtt tárolja az eseményazonosítót egyedi korlátozás alatt. Sikeres visszaküldés tartós átvétel után, majd aszinkron módon dolgozza fel. Az ismételt esemény sikert ad a mellékhatás megismétlődése nélkül. Forgassa az aláírási titkokat egy átfedési periódussal, és korlátozza a diagnosztikai kimenetet, hogy ne fedje fel az aláírásokat vagy a tartalmat.

Modellállapotok, például fogadott, érvényesített, egyeztetett, alkalmazott, figyelmen kívül hagyott, újrapróbálkozás és sikertelen. Párosítsa az eredményt a feladatazonosítóval, a forrásazonosítóval, a forrásváltozattal, a területi beállítással és a móddal. Ha az aktuális forrás újabb, tárolja az eredményt az ellenőrzéshez, de ne nyissa meg vagy cserélje ki az aktuális piszkozatot. Kezelje a renden kívüli eseményeket állapotátmeneti szabályok szerint, nem pedig érkezési sorrend szerint. Tartson egy visszajátszó eszközt, amelyhez ok, operátorazonosító és hatókör szükséges.

  1. 1

    Ellenőrizze a szállítást, a nyers törzs aláírását, az időbélyeget, az esemény típusát és a szerződés verzióját.

  2. 2

    Tartsa fenn az egyedi eseményt, és nyugtázza a tartós átvételt.

  3. 3

    A CMS cseréje előtt oldja meg a feladatot és a pontos forrásváltozatot.

  4. 4

    Alkalmazzon idempotens állapotátmenetet, és hozza létre az áttekinthető piszkozatot.

  5. 5

    Rögzítse a befejezést, vagy irányítsa az eseményt irányított újrapróbálkozáshoz és újrajátszáshoz.

Tegye a kötegeket reprodukálhatóvá és összeegyeztethetővé

Hozzon létre egy változtathatatlan jegyzéket kötegazonosítóval, létrehozási idővel, lekérdezési vagy kiválasztási szabállyal, egyedi cikkazonosítóval, forrásváltozattal, területi beállítással, móddal, prioritással és ellenőrző összeggel. Fagyassza le a jegyzéket elküldés előtt, hogy egy későbbi CMS lekérdezés ne változtassa meg a köteg jelentését. Oszd fel korlátozott darabokra, és használj stabil idempotencia kulcsokat minden elemhez. Ellenőrzőpont befejezése a tartós írások után, így a dolgozók újrakezdés nélkül folytathatják a munkát.

A végén egyeztetjük a benyújtott, elfogadott, befejezett, elutasított, elavult, sikertelen és szándékosan kihagyott tételeket. A számlálásnak az eredeti jegyzékhez kell igazodnia, és minden be nem fejezett tételhez ok szükséges, és a következő művelet. Egy részhalmaz ismételt lejátszása új, az eredetihez kapcsolt újrajátszási jegyzéket hoz létre. Ne módosítsa az eredeti számokat, és ne törölje a sikertelen bizonyítékokat. A kötegelt eredményeket csak felülvizsgálati állapotokban tegye közzé, a szerkesztői csapatot védő munkaterhelési korlátokkal.

  • A jegyzék javítja az elem azonosságát, a forrás verzióját, a beállításokat és az ellenőrző összeget.

  • Minden tételművelet idempotens és függetlenül újrapróbálható.

  • Az ellenőrzőpontok megszakítás után a piszkozatok megkettőzése nélkül folytatódnak.

  • A végső állapotok száma pontosan megegyezik a jegyzékkel.

  • A visszajátszás hatókörű, engedélyezett, összekapcsolt és auditálható.

Figyelje a sorokat és próbálja meg a helyreállítást

Figyelemmel kísérheti az elfogadott arányt, a befejezési arányt, a hibaarányt kategóriák szerint, a sormélységet, a legrégebbi tétel korát, a feldolgozási időtartam százalékpontjait, a webhook-ellenőrzési hibákat, az újrapróbálkozások számát, az elhalt levelek mennyiségét, az elavult eredmények arányát és az eredménytől a szerkesztői jóváhagyásig eltelt időt. Figyelmeztetés a felhasználói hatásokra és a növekvő lemaradásokra, nem pedig az elszigetelt átmeneti hibákra. Az irányítópultok elkülönítik a szolgáltatói feldolgozást, a visszahívási kézbesítést, a CMS alkalmazást és a szerkesztői várakozási időt.

A runbook azonosítja a tulajdonosokat, a biztonságos szünetet, a méretezési korlátokat, a hitelesítő adatok elforgatását, az újrajátszás jóváhagyását, a holtbetűk kezelését, a szolgáltatói kommunikációt és a helyreállítási ellenőrzést. Gyakorlat elveszett visszahívása, ismétlődő esemény, soron kívüli esemény, szolgáltatói leállás, CMS leállás, séma eltérés, lejárt titkosítás és részleges kötegbefejezés. Az elfogadáshoz ismétlődő közzététel, csendes elvesztés, kézi adatbázis-szerkesztés vagy az utolsó jóváhagyott tartalom eltávolítása nélküli helyreállítás szükséges.

Szerepek, bizonyítékok és jóváhagyás

A generálást tartsa külön a közzétételtől. A sikeres válasz tervezet, nem jóváhagyás. Tárolja a forrásazonosítót és verziót, az átalakítási beállításokat, az eredményazonosítót, a felülvizsgálati állapotot, a jóváhagyót és a közzétételi időt. Amikor a forrás megváltozik, a jóváhagyott tartalom csendes cseréje helyett jelölje meg a nyelvi verziót felülvizsgálatra. Ez lehetővé teszi a visszaállítást és az auditálást a platformok között.

Műveletek és karbantartás

A munka nem ér véget a megjelenéssel. Kapcsolja össze a nyelvi verziót vagy konfigurációt a forrásával, figyelje a minőségi és szolgáltatási intézkedéseket, és határozzon meg konkrét felülvizsgálati indítékokat. A kiváltó tényezők közé tartoznak a forrásváltozások, a jogi változások, az új közönségigények, az ismétlődő támogatási kérdések, a technikai változások és az incidensek. Egy megnevezett tulajdonos értékeli az eseményindítót, szükség esetén új verziót nyit meg, és rögzíti a megújított jóváhagyást.

Közzétételi ellenőrzőlista

  • Az integráció tartós forrásazonosítókat használ.

  • A hitelesítő adatokat a rendszer a szerver oldalon tárolja és elforgatja.

  • Meg van határozva az időtúllépés, az újrapróbálkozás és a sebességkorlátozás viselkedése.

  • Az ismételt kérések idempotensek.

  • A generált tartalom felülvizsgálati állapotba kerül.

  • A forrásmódosítások érvénytelenítik vagy újra megnyitják a verziót.

  • A nyelvi navigáció billentyűzettel és kisegítő technológiával működik.

  • A figyelés kiterjed a hibákra, a várólistákra, a várakozási időre és az elavult tartalomra.

Hiteles források

  1. Simple8 API dokumentáció
  2. Simple8 szállítási minták
  3. Webes tartalom hozzáférhetőségi irányelvei (WCAG) 2.2

Alkalmazza az útmutatót a gyakorlatban

Tesztelje a Simple8-t reprezentatív tartalommal, és használja az ellenőrzőlistát egy ellenőrzött gyártási munkafolyamat megtervezéséhez.

Teszteld a saját szövegedet