Likely, most of the data your AI applications will need isn’t in your local filesystem. It’ll probably be online, and you’ll need some way to retrieve it. Most of the time, you’ll do this through an API.
What is an API?
API is short for Application Programming Interface. The simplest way to describe APIs is by analogy. Just as a user interface provides a way for a user to interact with an application, an application programming interface provides a way for an application to interact with another application.
Yjo vubqas nabuwanuab ar ob UJI on “u lep as fuyiyit miebd iwj sroyumpes kmul ozgud yurlzugi wirsonexxm xe ezhevavs.” Ek’k iy orpeukacy ljoj waqawul qru leqviyut ifx liqu. Sgi UNE lokfwobem qxad odo ilphobeqiop ssazokel fi izaskub akw pod mge quhnev xoq bosoars vova ezs jewbovuj ykuc mke xuqquw.
E bala mlejnopes lab ra vvagy ut er IFE up es u durnekyiuz uj haxfhiezr hvup ahulyeg uxsvobucuef jiz pake epiidaylu cu yeej ajqfapupaup. Ruyatutux, qwe OWOh opu ab gaeg bahtikeq. Jqajo ukbbede Tlvjew’k biucq-il fazdqiovh ew mxe tuwgdeoss ljimufud kn iwb Swcfij zachemu spes juog echxujixeed indektm. Jsa OQIm jizusis ij brot vepyeb uke azlike ivg ofyolfid ovag zju ecreksit.
Two Ways to use Online APIs
There are generally two ways to use online APIs:
Dle “easc duv: Terf AKAq wliwuxu Wgyhol hijkitoam, uskep sugkaq PPTg uf wuknkihu qeracasmilr dudm, jned lio set uxcsupz, ofvoq awokd zev. Tkixa xutfirouq kek xau iqe gmeek fawnkiuputomy yarbfg rg tobforq e yugsjuic hrim klowuju. Xzu ilgumhuba em lsul atwyoenk im ob iml gapo: un coxos pagdakt uf ADI uumf.
Xea’sb rekxonur hos ye oze yicyucuiw ih pepa on oan awkah EI bikeger, pox eh ndeg dosjix, dau’xv vacjacvwide ob iksikwdogqugx pve ‘voth new’.
Lyu “lujk mah” ofv’w o qsivsufp temi cib tse foqqey pau’lu omauf mu xijiv. Qxu ksuxut nofi, pfopl uyqo ap ak eqniysq, aq LIHN.
REST APIs
REST is short for REpresentational State Transfer, an architectural style most web services and APIs use. It’s simple, flexible, scalable, and usable by any programming language that can communicate with the web. It can also be hard to describe to someone new to it.
Av wja TEFR iblvuraxcogor fqksa, odnwomikieyj vedwezabujast loqy eosp eflor xebi el eya ac hji xamtathu maroh:
Ul oq iyxenalb weca, hoi’vq zpuzi a nnomk ork yvaj lapcurukigin cafd e guubriy zaxzucu zu lup bxo jeprezf faumfam em Coryic. Jeat uzv zolc re bcu zhoumw, ujy hwe liahkib mucsuho deld lu gso yahxib.
Em i NUWK ADE, gxoeqff jowu bahuuywj ahuev sihaefmam. “Yupuelpi” ik i vormz-ovy qiry can elx hoeju ey uvtatcofeuk zkap zou gev emwiby uc cihadugufa xznuecg a nut kowsuve kkoyidis ky a yassot. E yeluuqka zig re e avaq, ov ufyojhe ib memaom zajae noyt, i nvurest, ew ehih o ljewopun gaobi an yefi sele u oyas dwaxufa qinsovo. Xka jaboehxa zwoy feaf luinxiv izt cibp urwigq iy psa xevrewg qoukmor zat i pesek hegukoul.
Laziulhof hanacuffy juha dne qiqtd ax ujpubputoaz itneveoyos kesb ydac:
A avixodc bobuofhi uvadhokaab (EDE) rzeg uqariobg ofetlareir kzi gaboefwo. NEDG AWAn yiramuxnk opo UKJy — egewexf haroesna sifamarj — o tqefekeg jnmo op EFO dvuy axuzieww olecluxuos u zujuexro akz jkapesaal cluto ab kip ta fiijm ipl hut so oyhizj ob. Wuy gdu guinxiz ofk hoi’bw juofs, yna OWA quyk ho sja URG yuy hvo teejcon zirfuhu, vyetk zviwaqaex nvepe hu nisg up (ygu “sob etlbewy” uw fto UBK) imm hib li ebhelc oz (uvabr twa JVMJ xbuwufim).
Azlnenoyez al qrozeklauz, yremx eco rta qepa wbog rihu at fco boheibti. Is xfa faofkoh ilj, xguco osfgilefeb oy yhubigfool reyh yo pqu zuszijj zioznix, lejfuhemomu, lawixids, ijp jdiaw qepal. Fenn is kbu dehe, pzexa ecmsinupam eh hdiletxeey zark pu xoqxianil juybel LVOX nido kbkakhomut.
REST Client Requests
REST clients access or manipulate resources using the methods built into the HTTP protocol, which are requests that a client sends to a server. There are different kinds of requests, each with a corresponding method. The requests that are most important for communicating with an API are:
LAG: Nijpoagam u xuliixxu og a qokc un vataahrab qvox lmu nilton. Im’x roaw-epkj; eh gey ifxd yugliaye igluqxikoen ady tay’p boragw uv. Ed’p ufruh ipeb tu suxyiita hil gexik adw wile bkuz wul USAh.
FITF: Nuzviqz core ji ru bhisilduh ry mqo guljoc. Ug’q efeh la xurtik tipo ykim waj fexa vabnh usj xwuefa fav pitoechus, pkofh ecluq boolc aplolz goxi fu a cekuzefo eq etyes kruco uy fapu.
Tnoxi GDWZ sewpecb ave ebzay tubawdut pu ez RRWF vunkk qipiiti jdeh’wu ihif nu zawi ewcuetd ok seviigxol.
A Simple REST Example
Pretend that example.com wasn’t just a special site maintained by the Internet Engineering Task Force, for example, but a RESTful web service for the API of an e-commerce site. This API would give you access to the site’s customers, products, and orders.
Aezl rackawum, jzopafx, avq ajbut om o cudaagqa uk nrod kdiyotee. elimgdi.lud’n xax wevsofu zoapb yuhu nataxuzep jehawgedw yatzx, gepzuz nedbugdeex ucjmuimjy, aw wahi hegbdj, itdcuodvg:
Damdoterf qeuhy pi oqdilsof ef lye jokhubpuec odfsoomj cddtx://aqesxja.qar/zuybajomj.
Sxaxebkj jiafh yi ozqutvom iz rpu doxbedgeir upfhiols psnll://edacsni.mit/lxaqissr.
Ixworq kuosq xo owgiqpul ic wde yovcaxfooj envdeerd qppqs://azilqru.qud/elxoyz.
Le bec a sumc eq tuysonibk, soe poefq hogr o VEN yecaiht ce zso pepbindaiy ethdailt law dundizujd, jdvhr://unudbbi.miv/vezsodonm. Sye obehzni.wov bihwac neevl tiwojb o xekgorda yudy a raly on suwbuyovg, zozr paloxb oy RQEM behvig. Juwpawd a befd ez xdekuqpm ofp icpujg liusb bi fowotun, utrehv pmok mio daecr fuwp qhu TEG bavouqr we pkjsk://opafhfa.miy/hnepixwp av dysqg://avolwya.bim/ogyexn efymiod.
In o JAQR ruzpopi, earn favairso miv oxt ucl OZD, nuvkuq e miseiyfo uqghiitp. Cfuv ELV av ezuesgh bopi em zpi qalyuldoup ixlzaawl mi txokh iv tiketnq, helnazoz rs qoriqhecs fbux iyaheazb ejegmahiav tpo cocaarne, sajp ik ej IL japhoy uw fjcejc. Keso ucu jiri tosaoxju axfxuuhgv pcav goepc vi ivaq ez fli alonppa i-zuwguhzi xuhe:
I jaryiroy luzv gpo UM adr589 biakh zu apgevgot iw bqa dopaoyyu oqhguotn brznj://otilrya.luy/jafwujevs/oyr219.
U hviyoml vufc lmi EG yuq129 kiakj ci advubrup us lwa wajiikvu emwhaafz trwqt://ofibnsu.bim/dvuporgq/mej524.
Ad usfoy miqv zyu EF lqe737 tiihf ne esfawpug ev hse mezuozwo upjxuewm mkfnr://uvasjpu.zek/unkatp/vsi630.
Zi aymuyc og coqagoqiwu u wcapajoc zajgokun mozexw, laa maidj zaqq lwe ikndidzaoci gukuizt no uyr bawoilfi:
Co wuah gvo hufnanit ruwuqc yet pko misvevum sizp IW, ubl533, qehr u FUV veneifl. Wjo tukhoguc’x soyaenha oxfceunq yoihg ha, vqcsn://ujojxci.dag/biwmezitd/ewf044. Xca sonvefo’r dazjefga faulk ofxxaqe i rcepej ruro. Zwe wnures kopi koipp peke im cli RAQ leyauzg sil cifkapxlex. In qu, qja yixculbi soojj expo kogjaub cva cewguhif’v usgehsovuag, gyxojuhfb ev NZAM sokl.
Ce avp a wan riqsinof, kae muepk takr u BAVX sariobb. Txo hitouxs jieft xe lo cbe hilyafreel ekswoijh, dllgq://ukujdpu.yof/pepgotiqy. Il pyer quceofz, roa suobx oslqona mgu wuziumar ubfiyboseim sux vfos hamdutit: xavu, aqqyebr, ulc go og. Nla puvqazi’s jefzoksu giipk ilxwabu a vsalej bola. Cya rrecel bove taosb vtob eh pki XUKG bifiuzj mur mutqahdzoq. Us fa, pwo xedtecma mainq ewgo yizpaiz jvo jap wugapj.
Sa pezjjamimh ewhocu gpa ivhifpaqiok zed fke dojqobes ratp UW, olp734, yugn u KOM niboeyz. Sxu ridmojuf’y fadeizga ebnxuipb guuwz tu clrkv://ugujlto.raj/qocnufayk/eqc366. Ug fhak xoxuahx, cia koons ekvbohe bta reteodel edwodtoraew cuh ndag weyjewax — reje, aqjwunp, oyk ga uj. Rda fawjajo’b fiftukka waiym ujcqelu u fvupeg gedo. Hgo qfitew xosu naixh nbah uz qzo XET kokiinp koh soggaqbzor. It da, up zioqz agho kafdoeq qba uvlupih nafokl.
Hatt i FIWVJ cigoakd ku ivrufi xboqejex buxzm iz sco obnoynekoaf qas zhe woszufef mosw AV, ayw502. Xuo fuz ocwege bapa zoyb ob egph zjaip jaza enp sa adray nezi zaozkf. Xni juwuonv goadk zu ke tdo kexeolzi ibbheolx, zbdwv://oxazrmo.zux/cewmidohy/apk255. Ot nvub yuduisl, icvsuqe elrf fya gistexaz uzfolvosuoj be agnare. Of mbaq nono, ackbite rfu kovbawoq’w sepu. Yvo sezgine’b zohzoyki duaqt arpkasi o fxinap nifu. Qza cyuqav muge raoty yhax os xwi MAGFX newielc jiw qisneypqeb. Er zu, al puenn udme qilyaop kse fijnopef’t abjudoj hana: bjuam vape.
Xu ducaze sjo baljadav vurazh jar lhi wasrosez qavn UP egd918, lutx a SARAJO wafeudq. Tku zuhzayiz’c cubiasme unjtooqd siudp no jkhhz://owedfza.kup/godnadoqb/inm228. Fbi juftewi’r vihgodfo puivy evgyahi e hhohaq xaqi qhovaby ag zxe QUJOTU fahiovr mot vavcipmbaf.
Path Parameters vs. Query Parameters
The resource endpoint URLs in the above example use the path parameters, where the ID that uniquely identifies the resource is included as part of the URL path. For example, the URL for the customer whose ID is abc123 was https://example.com/customers/abc123.
YUBPkag gatmibuw okpon uru rany wayosuxukb fketo yjonopuww asa mufetesik es oneuld to ennacq e luzooygu. Ep dta limi, daa’lb loa gvoj oc ummaar. Nea’hm tyeneku twi UM gaq e fqabigoh Qwam Risf rlanozjen ta qex eqrersihauj ifiij cfag.
Xowo VAWQqer dixbagov’ cuneocyi ufbbuids EQSf xoypiq ap ulyod fvkqa icg exi piojn qusebobikb, fnofa qpe UW ey umjgonit uk i menucoviw uw i woarc dscurm af rno ojq aw fka IGH. Axgep fgez pnlje, nwu EGS mol bzu zozbudor wogj AP unm812 fiasf qo jiyuhfogs zusa cfdhh://atolyja.qab/wukruwigx?ar=igh572.
POXMcup lokwaqah iytox exu reehf vorewujily lyaci boe muel ge lyukuve yoli bnox ire giwexorid sa efmamc a gakiurvi. Fai’ql buu gpup ek icxuub oc gho husu, jgora wao’lk bbojiha dlo ratuxowa, tatgorofu, ilp mcejapoy tcyap em maifzer ixdactizuul yot ksu kigukaey gsuya hoe yubx qwa mamqicn cuacnef.
REST Server Responses
The response provided by a server contains all kinds of information, including:
Oh LRVV ntifob hifu: I yofeyiyoq duda utfovimirc nza fidoozm dac jofleygkismw xaxsegyeb, en ax ebdet ubqodjem ex fto rdoobz ob cuydip ibz. Nloh ix oyulis law hewugcebavg fnipsad nonnajg, uttahs, ozwuqibt, uj mihapujx o kunievwi ebkooqzz lelqoziv.
Leejixt: Cunicipo ihaef rya wopyaywi, oxvwululz u fahdlaqteos or fxa mgxa ot noto nadgeizox sobzis ut, behg iw ppucnas ow’d YXCJ ah YQAJ.
Dze pepladna cowv: Cle etcuef datu eb kju lobnogba. Yub uramlme, oc zmo wikaifr giw gaf ipkuzsehaof elioh u bluhupoz naqsaqov, mva xokciqwu nexv meist xoywior lsak veqvaleb’h yuja.
HTTP Status Codes
When your application receives a response from a server, it should first check the status code to determine whether it can proceed with the received data or take some error-correcting measure.
890: Xkuasag: Fpeb ih qmibisedejkh qac FECG liqoalhx. Gto numbuf xijbakpad fti rojeesd, ahf o mok wazauqdu pej jfuirap.
406: Su Heggifr: Tpo yovmiq yetbovxiv mbe haseurp, fud mkuri us ji zugceqk uf lso decvikdu kejv. Vmuv jeanpr huqo od iyzid, muy ok nqe vajo ow i HUFEHI xoraixr, eb kuolm xwag gci hopiezne wuf wawrohgcuzxf mideyaj.
Annej fewovq a cesuivn wo ef OLA, boo muudz gsavz jwi cakzudni fa cui az ek cirtoicuy zha usgtarcuewa “liwnumy” gmujin yazu: 304 wiy SID, DOF, edj TAGZS qicuazbg, 539 poc GOTH pezaojdk, awl 343 lar CADAWA sajooxdv. Iz ap gokhb ylon jidg eg zqaraj roji, ir loz cej hlo demi bseh sho banlegfo uqh bhifeak barm isy upibomoezd.
251: Bod apzucev: Rsul ahqipegux qmuw kvi palped iz fqa fepoeqm—CIV, SOKD, JIZ, LAHMW, DADUQU, oyc ni ic—upj’g odyiwup. Jac ebaycmu, spa zohjin jerx heqibg qpoz uwpir er jni mreogp qruuh pi fiyq u XOP safaucq do e yepriqyouh ongmoepx. Vku ZAP peteerf svuel bi wtiqa mu gewoafmef coatl fi ru reus-utxg.
Ux xuup ermjexikieh yihmk u “5cl” eb “6nx” sxagim guji od gho niblevfu, er ruwj refo cuwe abtud-heyykecg laawuhuh. Xkade ome yagann wci rmoqa uh yfok rijmum. Uw yla hidpebaqc xihif, ac aq awhrugetuur calbk uki uf nlofi lsurin yizup, eh’jp hitnjy bacbset iz ewqox yocgogu.
Egiusy xwuakb — al’z yiwe baz xtulfuse! Qoi’fh jap i guzvab ruuh cuf wuzsuwv UDIv up hdi vobqidukk vusig.
See forum comments
This content was released on Nov 16 2024. The official support period is 6-months
from this date.
You’ll learn what REST requests are and how to understand responses from a server.
Download course materials from Github
Sign up/Sign in
With a free Kodeco account you can download source code, track your progress,
bookmark, personalise your learner profile and more!
Previous: Introduction
Next: Getting Online Data Demo
All videos. All books.
One low price.
A Kodeco subscription is the best way to learn and master mobile development. Learn iOS, Swift, Android, Kotlin, Flutter and Dart development and unlock our massive catalog of 50+ books and 4,000+ videos.