CMS ja API

Webhookit ja eräkäsittely.

Valitse synkroninen, webhook- tai erätoimitus volyymista, latenssista, uudelleenyrityksestä ja operatiivisesta omistajuudesta.

Selvitä tehtävä ja päätös

Tämä opas muuttaa webhookit ja eräkäsittelyn tarkistettavaksi toiminnankuluksi. Se yhdistää verkkotunnuksen päätökset, omistajuuden, todisteet ja hyväksynnän, jotta tulos toimii edelleen tuotannossa.

Valitse synkroninen, webhook- tai erätoimitus volyymista, latenssista, uudelleenyrityksestä ja operatiivisesta omistajuudesta.

Käytännön työnkulku

  1. 1

    Varaston lähdetyypit, tunnisteet, kentät, alueet, omistajat ja julkaisutilat.

  2. 2

    Valitse toimitusmalli äänenvoimakkuuden, latenssin, toimituksellisen ohjauksen ja virhetoleranssin joukosta.

  3. 3

    Yhdistä lähdetietue erilliseksi kieliversiotietueeksi kestävällä linkityksellä.

  4. 4

    Lisää todennus, idempotenssi, uudelleenyritys, välimuistin mitätöinti, lokikirjaus ja pääsynhallinta.

  5. 5

    Testijulkaisu, lähdemuutokset, tulokset, joita ei ole saatavilla, palautus, näppäimistön käyttö ja valvonta ennen julkaisua.

Esimerkki tai työkalu

Elinkaarikaaviosta tulee toteutussopimus uudelleenyrityksistä, idempotenssista, seurannasta ja toistosta. Tallenna työkaluun myös lähtökohta, omistaja, päätös, todisteet, avoin kysymys ja hyväksymispäivä. Käytä oikeaa sivua tai tapahtumaa, jotta tiimi näkee riippuvuudet, poikkeukset ja julkaisua seuraavat ylläpitotyöt.

PäätöskohtaTallentaaHyväksymiskriteeri
PerustasoHavaittu nykytilaLähde ja tallennuspäivämäärä
PäätösValittu vaihtoehto ja perustelutRiski ja yleisö huomioitu
TodisteetTestaa, dokumentoi tai mittaaTarkastettava ja versiokohtainen
HyväksyminenNimi, rooli ja päivämääräKaikki pakolliset kriteerit täyttyivät

Valitse toimitus viiveestä, määrästä ja omistajuudesta

Käytä synkronista toimitusta pienille interaktiivisille pyynnöille, jotka yleensä valmistuvat käyttöliittymän aikakatkaisun aikana ja voivat raportoida tuloksen välittömästi. Käytä webhookeja, kun työ on asynkronista, mutta jokaisen tuloksen tulee syöttää CMS heti, kun se on valmis. Käytä eräkäsittelyä suuriin ajoitettuihin kokouksiin, kontrolloituihin tuontiin tai siirtoihin, joissa suorituskyvyllä ja toistettavuudella on välitöntä toimitusta tärkeämpää. Mallit voivat esiintyä rinnakkain, mutta jokaisella sisältöluokalla tulee olla dokumentoitu oletusarvo.

Arvioi päivittäinen ja huippumäärä, nimikkeen koko, hyväksyttävä valmistumisaika, uudelleenyritysikkuna, tilausvaatimus, arvioijan kapasiteetti ja toimiva omistaja. Nopealla tuloksella ei ole arvoa, jos toimituksellinen jono ei pysty käsittelemään sitä. Sisällytä ylä- ja alavirran rajoitukset: CMS-vienti, API-nopeus, jonotyöntekijät, takaisinsoittopäätepiste, tietokannan kirjoitukset, välimuistin mitätöinti ja tarkistustyökuormitus. Valitse yksinkertaisin malli, joka täyttää koko palvelutavoitteen.

KuvioKäytä milloinOlennainen ohjaus
SynkroninenPieni pyyntö ja lyhyt rajattu latenssiAikakatkaisu turvallisella asiakasyrityksellä
WebhookItsenäisten töiden pitäisi saapua nopeastiAllekirjoituksen vahvistus ja idempotentti tapahtumien käsittely
EräSuuri ohjattu sarja ja aikataulutettu valmistuminenManifesti, tarkistuspiste, sovinto ja uusinta

Ota käyttöön todennettavissa oleva webhook-elinkaari

Hyväksy vain HTTPS POST, tarkista allekirjoitus raakatekstiin, tarkista aikaleiman toleranssi ja hylkää ei-tuetut tapahtumaversiot. Tallenna tapahtumatunnus yksilöllisen rajoituksen alle ennen liiketoimintamuutosten käyttöönottoa. Palauta menestys kestävän kuitin jälkeen ja käsittele sitten asynkronisesti. Toistuva tapahtuma palauttaa menestyksen toistamatta sivuvaikutusta. Kierrä allekirjoitussalaisuuksia päällekkäisyydellä ja rajoita diagnostiikkatulostusta, jotta se ei paljasta allekirjoituksia tai sisältöä.

Mallin tilat, kuten vastaanotettu, vahvistettu, sovitettu, käytetty, ohitettu, uudelleenyritetty ja epäonnistunut. Yhdistä tulos työn tunnuksen, lähdetunnuksen, lähteen version, kielen ja tilan kanssa. Jos nykyinen lähde on uudempi, tallenna tulos tarkastusta varten, mutta älä avaa tai korvaa nykyistä luonnosta. Käsittele poikkeavia tapahtumia tilan siirtymäsääntöjen mukaan saapumisjärjestyksen sijaan. Pidä toistotyökalu, joka vaatii syyn, operaattorin identiteetin ja laajuuden.

  1. 1

    Tarkista kuljetus, raakakappaleen allekirjoitus, aikaleima, tapahtumatyyppi ja sopimusversio.

  2. 2

    Jatka ainutlaatuista tapahtumaa ja vahvista kestävä kuitti.

  3. 3

    Ratkaise työ ja tarkka lähdeversio ennen CMS:n vaihtamista.

  4. 4

    Käytä idempotenttitilasiirtymää ja luo tarkistettava luonnos.

  5. 5

    Tallenna valmistuminen tai ohjaa tapahtuma ohjattuun uudelleenyritykseen ja toistamiseen.

Tee eristä toistettavia ja sovitettavia

Luo muuttumaton luettelo erätunnuksella, luontiajalla, kyselyllä tai valintasäännöllä, yksittäisellä nimikkeellä, lähteen versiolla, maa-alueella, tilalla, prioriteetilla ja tarkistussummalla. Pysäytä luettelo ennen lähettämistä, jotta myöhempi CMS-kysely ei voi muuttaa erän merkitystä. Jaa se rajattuihin osiin ja käytä vakaita idempotenssiavaimia jokaiselle kohteelle. Tarkistuspisteen valmistuminen kestävien kirjoitusten jälkeen, jotta työntekijät voivat jatkaa aloittamatta alusta.

Lopuksi sovita lähetetyt, hyväksytyt, valmiit, hylätyt, vanhentuneet, epäonnistuneet ja tarkoituksella ohitetut kohteet. Laskujen on oltava tasapainossa alkuperäisen luettelon kanssa, ja jokainen keskeneräinen kohde tarvitsee syyn ja seuraavan toimenpiteen. Osajoukon toistaminen uudelleen luo uuden toistoluettelon, joka on linkitetty alkuperäiseen. Älä muuta alkuperäisiä laskelmia tai poista epäonnistuneita todisteita. Julkaise erätulokset vain tarkistustiloihin, ja toimitustiimiä suojaavat työmäärärajoitukset.

  • Luettelo korjaa kohteen identiteetin, lähdeversion, asetukset ja tarkistussumman.

  • Jokainen tuotetoiminto on idempotentti ja itsenäisesti uudelleen yritettävä.

  • Tarkistuspisteet jatkuvat keskeytyksen jälkeen ilman luonnosten kopioimista.

  • Lopulliset tilamäärät täsmäävät täsmälleen manifestin kanssa.

  • Toisto on rajattu, valtuutettu, linkitetty ja tarkastettavissa.

Valvo jonoja ja harjoittele palautumista

Tarkkaile hyväksyttyä määrää, valmistumisastetta, virheprosenttia luokittain, jonon syvyyttä, vanhimman kohteen ikää, käsittelyn keston prosenttipisteitä, webhook-vahvistusvirheitä, uudelleenyritysten määrää, kuolleiden kirjainten määrää, vanhentuneiden tulosten määrää ja aikaa tuloksesta toimitukselliseen hyväksyntään. Varoitus käyttäjävaikutuksista ja kasvavasta ruuhkasta yksittäisten ohimenevien vikojen sijaan. Hallintapaneelit erottavat palveluntarjoajan käsittelyn, takaisinsoittotoimituksen, CMS-sovelluksen ja toimituksellisen odotusajan.

Runbook tunnistaa omistajat, turvallisen tauon, skaalausrajat, tunnistetietojen vaihdon, uudelleentoiston hyväksynnän, kuolleiden kirjainten käsittelyn, palveluntarjoajan viestinnän ja palautuksen vahvistuksen. Harjoituksen menetetty takaisinsoitto, toistuva tapahtuma, epäjärjestyksessä oleva tapahtuma, palveluntarjoajan katkos, CMS-katkos, skeeman yhteensopimattomuus, vanhentunut salaisuus ja erän osittainen valmistuminen. Hyväksyminen edellyttää palautusta ilman päällekkäistä julkaisua, hiljaista katoamista, manuaalista tietokannan muokkaamista tai viimeisen hyväksytyn sisällön poistamista.

Roolit, todisteet ja hyväksyntä

Pidä sukupolvi erillään julkaisusta. Onnistunut vastaus on luonnos, ei hyväksyntä. Tallenna lähteen tunniste ja versio, muunnosasetukset, tuloksen tunniste, tarkistuksen tila, hyväksyjä ja julkaisuaika. Kun lähde muuttuu, merkitse kieliversio tarkistettavaksi sen sijaan, että korvaisit hyväksytyn sisällön hiljaa. Tämä mahdollistaa palautuksen ja tarkastuksen eri alustoilla.

Käyttö ja huolto

Työ ei lopu julkaisuun. Linkitä kieliversio tai kokoonpano sen lähteeseen, seuraa laatu- ja palvelutoimenpiteitä ja määritä konkreettisia tarkistuskäynnistimiä. Triggereitä ovat lähteen muutokset, lakimuutokset, uudet yleisötarpeet, toistuvat tukikysymykset, tekniset muutokset ja tapaukset. Nimetty omistaja arvioi triggerin, avaa tarvittaessa uuden version ja kirjaa uusitun hyväksynnän.

Julkaisun tarkistuslista

  • Integraatiossa käytetään kestäviä lähdetunnisteita.

  • Tunnistetiedot tallennetaan palvelinpuolelle ja niitä kierretään.

  • Aikakatkaisu, uudelleenyritys ja nopeusrajoitus on määritelty.

  • Toistuvat pyynnöt ovat idempotentteja.

  • Luotu sisältö siirtyy tarkistustilaan.

  • Lähteen muutokset mitätöivät version tai avaavat sen uudelleen.

  • Kielinavigointi toimii näppäimistön ja aputekniikan avulla.

  • Valvonta kattaa viat, jonot, latenssin ja vanhentuneen sisällön.

Luotettavat lähteet

  1. Simple8 API -asiakirjat
  2. Simple8 toimitustavat
  3. Verkkosisällön saavutettavuusohjeet (WCAG) 2.2

Ota opas käyttöön

Testaa Simple8:tä edustavalla sisällöllä ja käytä tarkistuslistaa hallitun tuotannon työnkulun suunnitteluun.

Testaa omaa tekstiäsi