Pradžia/Įžvalgos/Programavimas
ProgramavimasPraktinis gidas

API integracija: ką sutarti prieš pradedant programuoti?

Dvi sistemos gali turėti API, bet vis tiek skirtingai suprasti tą patį užsakymą. Prieš programuojant svarbu sutarti dėl duomenų, jų pakeitimų ir išimčių.

API integracija: ką sutarti prieš pradedant programuoti? — iliustracija

Nuspręskite, kur informacija yra pagrindinė

Produktas gali būti valdomas vienoje sistemoje, užsakymas — kitoje. Aptarkite, kur keičiamos kainos, likučiai ir kliento duomenys. Atskirai nuspręskite, kaip atpažinsite tą patį įrašą abiejose pusėse. Jei abi sistemos gali keisti tuos pačius laukus, reikia aiškios konfliktų taisyklės. Šie sprendimai apsaugo nuo teisingos informacijos perrašymo ir dublių.

Suderinkite laukus ir įvykius

Paruoškite laukų atitikmenis, privalomas reikšmes ir identifikatorius. Pavyzdžiui, vienoje sistemoje pristatymo adresas gali būti vienas laukas, kitoje — keli atskiri. Nuspręskite, kada duomenys turi keliauti: sukūrus įrašą, jį patvirtinus ar nustatytu periodiškumu. API dokumentacijoje patikrinkite, ar tokie veiksmai galimi ir kokie taikomi ribojimai.

Numatykite pakartojimus ir klaidas

Ryšys gali nutrūkti jau po to, kai kita sistema priėmė įrašą. Pakartotinė užklausa tokiu atveju neturi sukurti antro užsakymo. Taip pat aptarkite trūkstamus laukus, atmestą formatą ir nepasiekiamą sistemą. Nurodykite, kas registruojama, kada perdavimas kartojamas ir kuriuos atvejus peržiūri žmogus. Prieigoms suteikite tik tuos veiksmus, kurių integracijai reikia.

Tikrinkite tai, kas nutiks kasdienybėje

Bandymuose turi būti naujas įrašas, atnaujinimas, pakartotinis įvykis ir netinkami duomenys. Išbandykite ir laiką, kai viena sistema nepasiekiama. Po paleidimo sutarkite, kas stebės perdavimą bei rūpinsis pakeitimais atnaujinus API. Dokumentuoti laukai, taisyklės ir klaidų sprendimas padeda integraciją prižiūrėti, net kai prie projekto prisijungia kitas žmogus.

Plačiau: Individualus programavimas

Kokią funkciją norite sukurti?

Aprašykite, ką naudotojas turėtų galėti padaryti. Jei turite esamą projektą, pridėkite informaciją apie jo technologijas ir svarbiausią užduotį.

Parašyti mums