API integratsioonid

API-integratsioonid, mis panevad süsteemid omavahel andmeid vahetama.

Liidestame Eestis veebilehti, e-poode ja ärisüsteeme kokkulepitud API-dega. Töö algab lähte- ja sihtsüsteemi, andmeväljade, autentimise ning vigade kaardistamisest, et automaatne andmevahetus oleks jälgitav ja arusaadav.

Räägime projektist

Milliseid ühendusi ettevõtted vajavad

Andmed liiguvad käsitsi

Tellimusi, kliente või tooteid kopeeritakse süsteemide vahel ning vigade leidmine võtab aega.

Veeb vajab välist teenust

Kasutaja tegevus sõltub maksest, logistika-, registri-, hotelli- või muust kokkulepitud API-st.

Protsessi olek pole nähtav

Ühendus peab salvestama tulemuse, vea ja korduskatse nii, et haldaja saab olukorrast aru.

Integratsioon algab andmete omanikust

Üks süsteem vastutab iga põhiandme eest

Enne ühenduse ehitamist määrame, kus tekib klient, toode, hind, broneering või tellimus ning millises süsteemis seda tohib muuta. Kui mõlemad pooled võivad sama välja parandada, on vaja konfliktireeglit, mitte ainult kahesuunalist ühendust.

API olemasolu ei tähenda valmis liidestust

Kontrollime dokumentatsiooni, autentimisviisi, päringupiiranguid, testkeskkonda ja näidisvastuseid. Eriti oluline on teada, kas vajalik sündmus on API kaudu kättesaadav ning kuidas eristatakse uut, muudetud ja kustutatud kirjet.

Automaatika vajab nähtavat vastutust

Iga andmevoo juures lepime kokku, kes märkab vea, kes saab seda korrata ja millal peab inimene andmeid parandama. Ilma selle omanikuta võib tehniliselt töötav ühendus jätta ettevõtte teadmatusse just erandjuhtumi ajal.

Mida integratsiooni arendus sisaldab

Mida integratsiooni arendus sisaldab

  • Lähte- ja sihtsüsteemi API analüüs
  • Andmeväljade ja olekute vastendus
  • Autentimine ning ligipääsude piiritlemine
  • Vigade, korduskatsete ja duplikaatide käsitlemine
  • Testkeskkond, logimine ja kokkulepitud seire

Integratsiooni hindamiseks vajalik materjal

Andmevoo kirjeldus

Kirjeldage käivitav sündmus, lähte- ja sihtsüsteem, vajalikud väljad ning oodatav tulemus. Näidis ühest tavalisest ja ühest vigasest juhtumist on sageli kasulikum kui üldine soov süsteeme ühendada.

Dokumentatsioon ja testipääs

Vajame kasutatava API versiooni, autentimise juhist, piiranguid ja testandmeid. Ligipääsuandmeid ei lisata lähteülesandesse; need antakse kokkulepitud turvalise kanali kaudu alles teostuseks.

Olekud ja veaomanik

Koondame võimalikud olekud, puuduvad väljad, korduvad sõnumid ja teenuse katkestuse käitumise. Tellija nimetab inimese või rolli, kes saab vajadusel algandmeid parandada ja korduskatse heaks kiita.

Kontrollitav andmevahetus

01

Leping ja piirid

Täpsustame, millal vahetus käivitub, millised andmed liiguvad ja kumb süsteem on iga välja allikas.

02

Turvaline ühendus

Rakendame teenuse toetatud autentimisviisi ja hoiame ligipääsud vajalikus ulatuses.

03

Veaolukorrad

Kirjeldame aegumise, puudulike andmete, korduste ja teenuse katkestuse käitumise.

04

Test ja jälgitavus

Kontrollime tavapärased ning erandlikud juhtumid ja teeme tulemuse haldajale leitavaks.

Ühenduse vastuvõtukriteeriumid

Ühenduse vastuvõtukriteeriumid

  • Andmeväljade tähendus ja omanik on kinnitatud
  • Autentimine ning päringupiirangud on testitud
  • Duplikaadid ja puuduvad andmed annavad määratud tulemuse
  • Katkestus, korduskatse ja käsitsi sekkumine on eristatavad
  • Logi sisaldab vea lahendamiseks vajalikku, kuid mitte tarbetuid isikuandmeid

Seire ja vastutuse üleandmine

Käivitamisel kontrollime esimesed andmevahetused ning lepime kokku, millist teadet loetakse tavaliseks veaks ja milline vajab kiiret sekkumist. Üleandmine kirjeldab logide asukoha, korduskatse viisi, välise teenuse kontaktisiku ja selle, kes vastutab väljade või API versiooni hilisema muutuse eest. Seire peab näitama ka viimast edukat vahetust, et vaikne katkestus ei jääks üksnes veateate puudumise tõttu märkamatuks.

Ühendused osana veebiteenusest

Hotelfest

Hotelfesti avalik kasutusloogika seob sihtkoha ja otsingu sisendid, filtrid, majutuskoha info ning broneeringu jätkamise etapid üheks veebiteenuseks.

Tutvu projektiga
Hotelfesti kasutatud Veneetsia sihtkoha foto
Hotelfesti kasutatud Kreeka saare foto
Hotelfesti kasutatud Itaalia sihtkoha foto

Küsimused API-integratsioonide kohta

Mida on integratsiooni hindamiseks vaja?+

Vaja on API dokumentatsiooni või ligipääsu testkeskkonnale, näidisandmeid, soovitud andmevoogu ja teadaolevaid piiranguid.

Kuidas käsitletakse katkestusi?+

Lahendus sõltub teenusest. Tavaliselt määrame veateate, logi, korduskatse ja olukorra, kus inimene peab sekkuma.

Kas integratsioon võib asendada käsitsi sisestamise?+

Jah, kui andmeallikas, väljade tähendus ja käivitustingimused on üheselt määratud. Erandid tuleb siiski eraldi kirjeldada.

Kas olemasolevat ühendust saab parandada?+

Saab. Alustame logidest, dokumentatsioonist ja korduvatest veaolukordadest ning piiritleme paranduse enne muudatusi.

API-integratsioonid, mis panevad süsteemid omavahel andmeid vahetama.

Kirjeldage lühidalt eesmärki, kasutajaid, tänast lahendust ja funktsioone, mida vajate. Esimeses vestluses täpsustame küsimused ning lepime kokku, millist kaardistust on enne pakkumist vaja.

Räägime projektist