API-liidestus
Soovite seadistada kahe teenuse vahelise andmevahetuse: näiteks et veebilehe päringuvormi kaudu tulnud taotlused jõuaksid automaatselt CRM-i, tooted ja laoseis sünkroonitaks e-poega ning tarne staatused jõuaksid tagasi kliendi vaatesse. Kirjeldage taotluses just seda ahelat ja seda, mida tuleb teha tõrke korral.
Valmistage ette mõlema teenuse dokumentatsioon: meetodite kirjeldus, päringute limiidid, autoriseerimise vorming. Lisage näide tegelikest andmetest – üks tellimus või üks taotlus JSON-vormingus ja vastuse väljavõte. Märkige, kuidas arendaja saab juurdepääsu testkeskkonnale ja kes vastutab võtmete eest. Loetlege eraldi erijuhtumid: mida teha, kui teenus tagastab vea või ei vasta õigeaegselt.
Tulemus ei ole ainult õnnestunud andmevahetus, vaid ka vigade käsitlemine, korduspäringud katsete arvu piiranguga, logimine ja selge võtmete hoiustamise kord. Paluge testkeskkonnas näidata kahte stsenaariumi: tavaline taotluse edastamine ja ühe teenuse tõrge.
Vastuvõtul kontrollige logide järgi, et andmed jõuavad kohale kadudeta ja duplikaatideta ning et korduspäring ei tekita ülearuseid kirjeid. Veenduge, et võtmeid ei hoita avatud kujul koodis ega kirjavahetuses. Kui sünkroonimine puudutab tooteid, võrrelge mitut artiklit ja hinda. Kirjalik kirjeldus selle kohta, kuidas andmevahetust uuesti käivitada ja kuhu vea korral vaadata, katab hilisema toe vajaduse.
Avalda ülesanne või paku oma teenust.