API integrácia spája produkt SaaS s inou aplikáciou, vďaka čomu si tieto dva systémy môžu vymieňať údaje alebo spúšťať akcie. Počas náhrady za SaaS je toto rozhranie súčasťou rozsahu migrácie. Nahradenie viditeľného produktu bez vyriešenia prepojených dátových tokov môže prerušiť širšie obchodné procesy.
Čo obsahuje API integrácia
Integrácia je viac než len adresa koncového bodu (endpoint). Zahŕňa operácie, ktoré systém volá, dátový formát, identifikátory, prístupové údaje, spracovanie chýb, časovanie a pravidlá pre opakované pokusy. Naplánované úlohy a prepojenia riadené udalosťami môžu rovnaké API využívať odlišne. Každé z týchto správaní je potrebné pochopiť ešte pred odstránením pôvodného produktu.
| Prvok | Čo zdokumentovať | Otázka pri náhrade |
|---|---|---|
| Operácie | Používané požiadavky a odpovede | Ktoré funkcie musia zostať zachované? |
| Údaje | Polia, identifikátory a vzťahy | Ako ich reprezentuje nový model? |
| Prístup | Kľúče, tokeny, rozsahy (scopes) a vlastníci | Ako sa zmenia prístupové údaje? |
| Časovanie | Udalosti, plány a pravidlá opakovaných pokusov | Kedy by sa mali údaje prenášať? |
| Riešenie chýb | Chyby, výstrahy a manuálna obnova | Kto zasiahne, ak volanie zlyhá? |
Prehľad rozhraní by mal obsahovať aj informáciu o tom, ktorá strana spúšťa jednotlivé výmeny údajov. Tento rozdiel ovplyvňuje ostrý prechod, pretože odchádzajúce volanie z produktu SaaS a prichádzajúce volanie z iného systému vyžadujú odlišné zmeny.
Prečo integrácie definujú rozsah náhrady
Integrácia môže preniesť požadovaný pracovný postup za hranice samotného produktu. Zmena stavu môže aktualizovať finančné údaje, odoslať správu, vytvoriť dokument alebo začať prácu v inom nástroji. Mapovanie iba obrazoviek a polí tieto vplyvy prehliada. Rozhodnutia o jedinom zdroji pravdy sú tiež dôležité, pretože sa môže zdať, že rovnaký záznam vlastnia oba prepojené systémy.
Tento odhad zvyčajne identifikuje:
- Priame API volania: synchrónne požiadavky medzi produktom a iným systémom.
- Naplánované prenosy: pravidelné importy, exporty alebo zosúlaďovacie úlohy.
- Doručovanie udalostí: notifikácie, ktoré spúšťajú nadväzujúce akcie.
- Manuálna obnova: kroky, ktoré ľudia vykonávajú, ak automatizovaná výmena zlyhá.
- Skrytí spotrebitelia: reporty alebo skripty závislé od exportovaných údajov.
Ako sa prepojenie presúva
Nový systém môže rozhranie replikovať, poskytnúť nové, presunúť toto správanie priamo do vlastneného systému alebo odstrániť prenos, ktorý už neslúži pracovnému postupu. Voľba závisí od požadovaného výsledku, nie od kopírovania dizajnu dodávateľa.
Integračné testovanie overuje, či nové prepojenie správne spracováva očakávané požiadavky, údaje, oprávnenia a zlyhania. Ostrý prechod následne presmeruje volajúcich, úlohy, webhooky a prístupové údaje v riadenom poradí. Monitorovanie musí rozlišovať oneskorenú prevádzku od zlyhanej, aby sa tím mohol rozhodnúť, či bude pokračovať, alebo využije svoj plán návratu.
Čo znamená dokončenie
API integrácia je dokončená, keď nové riešenie podporuje požadovanú obchodnú výmenu a jeho prevádzkové vlastníctvo je jasné. Dokumentácia by mala uvádzať, kto integráciu spravuje, kde sú viditeľné zlyhania, ako sa obmieňajú prístupové údaje a ako sa posudzujú zmeny v oboch systémoch.
Príbeh o systéme vybudovanom na viacerých nástrojoch SaaS ukazuje, ako sa obmedzenia rozhraní môžu stať obmedzeniami celej aplikácie. Ak k prepojeniam pristupujete ako k migračným komponentom, zviditeľníte tieto závislosti ešte pred skončením predplatného.