Zdroj a pravidlá prenosu
Kde vzniká správny údaj? Ujasníme hlavný zdroj, prístup k API, smer prenosu aj podmienky použitia. Dostupnosť dokumentácie a oprávnení overíme skôr, než sľúbime konkrétne prepojenie.
Andrej Srna · systémy, ktoré spolupracujú
API integrácie – prepojenie webu a externých systémov
Údaj vznikne v jednom systéme. Na vašom webe má byť užitočný, nie znovu ručne prepísaný. Navrhnem prepojenie od zdroja cez mapovanie polí až po zobrazenie a ďalší krok návštevníka.
DÁTOVÁ CESTA / ilustračný návrh
Externý systém
Zdroj ponúk
názov · kategória · miesto · odkaz
API → kontrola a mapovanie polí
location→Miestocategory→Kategória
Váš web / prehľad a výber
Kategória: pomocMesto: ukážka
Ukážková príležitosť
Zrozumiteľný výber z externých údajov.
Pokračovať na pôvodný detail ↗Prepojiť údaje.
Nie iba vložiť okno.
API integrácia pracuje s údajmi druhej služby a prispôsobí ich vášmu procesu. Vložený formulár či iframe môže byť vhodný na jednoduchý zber odpovedí, ale sám osebe nerieši mapovanie ponúk, ich vlastné zobrazenie a filtrovanie.
Najprv spolu prejdeme, čo dnes prepisujete, ktorý systém je zdrojom pravdy a kde má používateľ dokončiť svoju úlohu. Ak stačí existujúci konektor, nemusíme vyvíjať vlastné riešenie.
Rozsah podľa vášho procesu
Od dostupného API po použiteľný web
Mapovanie do vášho webu
Názov, kategória alebo miesto môžu mať v každom systéme iný formát. Navrhnem prevod polí, identifikáciu rovnakého záznamu a správanie pri zmene či odstránení položky.
Zobrazenie a ďalší krok
Prenesené dáta majú slúžiť návštevníkovi: prehľadné karty, filtre alebo detail podľa zadania. Dohodneme, či sa celá úloha dokončí na vašom webe, alebo pokračuje v pôvodnom systéme.
Chyby, prístupy a údržba
Prístupové údaje patria na server, nie do verejného kódu. Pri návrhu riešime kontrolu vstupov, limity poskytovateľa, testovacie prostredie a zodpovednosť za zmeny API po nasadení.
Referencia · ponuky z externej databázy
Dobrovoľnícke centrum TT: z DOBRObázy na regionálny web
Pre Dobrovoľnícke centrum Trnavského kraja som riešil API prepojenie ponúk s DOBRObázou na platforme GROWNi.
Návštevník regionálneho webu si prezerá zoznam dobrovoľníckych príležitostí a vyberá podľa kategórie a mesta. Z ponuky pokračuje na pôvodný detail na GROWNi. Web tak poskytuje miestny vstup do širšej databázy bez toho, aby návštevník musel začínať všeobecným hľadaním.
Príklad verejne viditeľnej cesty: ponuka „Pomoc pri sťahovaní“ na regionálnom webe presmeruje na jej detail na GROWNi. Ide o ukážku napojenia obsahu, nie o vloženie Google Forms.
Postup spolupráce
Najprv overiť možnosti. Potom prepájať.
Prejdeme proces a dokumentáciu
Určíme údaje, smer prenosu, očakávanú aktuálnosť, oprávnenia a limity API. Dohodneme rozsah, cenu, prevádzkové náklady a podmienky prevzatia.
Navrhneme mapovanie a malý funkčný celok
Na testovacích dátach overíme prenos a zobrazenie. Ujasníme identifikátory, prázdne hodnoty, zmenené položky a to, čo má zostať v pôvodnom systéme.
Otestujeme aj neúspešný scenár
Pred nasadením preveríme výpadok, neúplnú odpoveď, limity a riziko duplicitného spracovania. Dokumentáciu, prístupy, nasadenie a ďalšiu údržbu odovzdáme podľa dohody.
Jedno prepojenie alebo celá aplikácia?
Táto služba rieši dátovú cestu medzi existujúcimi systémami. Pre nový pracovný nástroj od zadania po nasadenie je tu vývoj webových aplikácií na mieru. Ak potrebujete širšie zmeny serverovej logiky, pozrite si PHP vývoj aplikácií a CMS.
Pre samostatné rozšírenie administrácie WordPressu ponúkam tvorbu WordPress pluginov. Platby, dopravu a fakturáciu e-shopu rieši osobitne stránka WooCommerce integrácie.
Otázky pred API integráciou
Čo je API integrácia a kedy má zmysel?
Je to dohodnuté prepojenie systémov na prenos údajov. Má zmysel napríklad vtedy, keď chcete ponuky z externej databázy zobraziť na vlastnom webe alebo nahradiť opakované prepisovanie záznamov. Najprv overíme, či stačí hotový konektor alebo nastavenie existujúcej služby.
Viete prepojiť aj existujúci WordPress web?
Áno, podľa dostupného API a stavu webu môžeme riešiť napojenie aj v existujúcom WordPresse. Rozhodneme, ktoré údaje sa majú ukladať, ako sa zobrazia a čo zostane spravované v pôvodnom systéme. Samostatný plugin je možnosť, nie automatická podmienka každej integrácie.
Budú sa údaje meniť okamžite a oboma smermi?
Nie automaticky. Smer prenosu, spôsob spustenia a požadovanú aktuálnosť dohodneme podľa procesu a možností poskytovateľa API. Pravidelné načítanie, ručný podnet či webhook sú rôzne možnosti. Obojstranná synchronizácia vyžaduje aj pravidlá konfliktov a oprávnenia na zápis.
Čo ukazuje referencia Dobrovoľníckeho centra TT?
Integráciu ponúk z DOBRObázy na platforme GROWNi do regionálneho webu. Verejne je viditeľný zoznam ponúk s výberom kategórie a mesta a cesta na pôvodný detail na GROWNi. Netvrdím tým okamžitú alebo obojsmernú synchronizáciu ani konkrétny interval aktualizácie.
Čo sa stane pri chybe alebo výpadku API?
Toto správanie navrhneme pred vývojom: čo ukázať návštevníkovi, či zachovať posledné dostupné údaje a ako oznámiť problém správcovi. Overíme neplatné a neúplné odpovede, limity API, duplicity aj prípadné opakovanie prenosu. Konkrétny postup závisí od rizík a možností oboch systémov.
Čo potrebujete na cenovú ponuku?
Opis súčasného postupu, názvy prepájaných systémov, dostupnú verejnú dokumentáciu API a informáciu, ktoré údaje a ktorým smerom sa majú prenášať. Cena, termín, prevádzka a údržba sa dohodnú podľa rozsahu. Heslá, API kľúče ani osobné údaje neposielajte cez kontaktný formulár.
Ktoré systémy majú spolupracovať?
Napíšte, odkiaľ majú údaje prichádzať a čo s nimi má váš web robiť. Bez hesiel, API kľúčov či osobných údajov.
Radšej e-mail? [email protected]