Povezivanje na API -je bez koda: 8 koraka

2024 Autor: John Day | [email protected]. Zadnja promjena: 2024-01-30 09:33

Ovaj je vodič namijenjen ljudima koji žele postići nešto što zahtijeva korištenje API -ja, ali nisu sigurni kako započeti. Već znate zašto je korisno raditi s API -jem, a ovaj će vam vodič pokazati kako to učiniti.

Ako to zvuči kao ti, imaš sreće! Ovdje smo da vam objasnimo kako raditi s API -jem, kako čitati API dokumente i kako zapravo koristiti podatke koji dolaze iz API -ja.

Poveli smo prijatelja koji će vam znatno olakšati putovanje.

Upoznajte Slash

Slash je Michellein preslatki, ljupki pas (na slici gore). Michelle je softverska inženjerka koja gradi API -je. Michelle zaista uživa u svom poslu i crpila se iz svog rada na izgradnji API -ja u obuci Slash -a.

Kao što možda znate, API je zbirka naredbi koje korisnik može dati web usluzi zajedno sa skupom odgovora koji odgovaraju zahtjevu. Michelle je istrenirala Slasha da učini isto. Slash je dobar dječak, zna razne naredbe i uvijek ispravno reagira sve dok mu date zahtjev koji je naučio. Kad se dodatno uzbudi, rep mu poludi - ovo ga Michelle nije naučila vezano uz API -je, to je samo zato što je ljupko štene i stvarno uživa u svom treningu!

Korak 1: Odlučite koji vam API treba

Koje podatke tražite ili želite promijeniti?

Pokušavate li zgrabiti sve Instagram postove @dougthepug? Možda želite automatski tvitati svakome tko prati twitter vašeg psa (jer iako psi ne mogu govoriti, imaju puno toga za reći, znamo da Slash to sigurno radi).

Ako već znate web lokaciju ili API s kojim se pokušavate povezati, prijeđite izravno na korak 2. Ako pokušavate pronaći podatke, ali niste sigurni odakle započeti, Google vam je prijatelj. Potražite "[stvari koje vas zanimaju] API" i pogledajte što će se pojaviti. Možda ćete se iznenaditi koliko informacija ima vani.

Ako želite jednostavan primjer API -ja, možete koristiti onaj koji je Michelle napravila tijekom treninga Slash -a. Ima neke od njegovih omiljenih naredbi poput vađenja lopti i kopanja rupa. Koristit ćemo ga u ostatku naših primjera.

2. korak: Pronađite API dokumente

API-ji koje pružaju poznate tvrtke trebaju imati temeljitu dokumentaciju o tome kako ih koristiti.

Da biste ih pronašli, google "[Insert Company] API documentation" ili "[Insert Company] developer".

Rezultati bi vas trebali odvesti na portal za razvojne programere. Potražite vezu koja kaže "Dokumenti", "Dokumentacija", "Referenca" ili "Tehnička referenca".

Unutar dokumenata možda ćete morati potražiti određeni API koji želite jer ponekad može postojati mnogo opcija. Facebook, na primjer, ima zasebne API -je za marketing, oglase, stranice i drugo.

Ako API s kojim se želite povezati nije dobro poznat (poput Slash -ovog), možda ćete morati zatražiti dokumentaciju od razvojnog programera. Mogu imati PDF koji sadrži potrebne informacije ili internetsku dokumentaciju koja nije navedena na njihovoj web stranici.

Ako ste propustili vezu u prethodnom koraku, Slash -ove API dokumente možete pronaći ovdje.

Korak 3: Pronađite krajnju točku

API dokumenti mogu izgledati zastrašujuće, ali kad jednom znate što tražite, obično su dobro strukturirani i prilično standardizirani.

Prvo što trebate potražiti su odgovarajuće krajnje točke. Trebalo bi postojati jedna krajnja točka koja odgovara svakoj vrsti podataka koje želite. Krajnja točka bi mogla izgledati ovako:

slashtheapidog.com/api/bones/{id}

ili samo

/kosti

Dokumentacija bi trebala imati popis krajnjih točaka. Mogu biti na najvišoj razini u dokumentima ili u odjeljku pod nazivom "referenca", "krajnje točke" ili "metode". Da biste pronašli pravu krajnju točku, potražite naziv koji odgovara podacima koje tražite. Na primjer, ako želite popis svih rupa koje je Slash iskopao, /rupe su vjerojatno one prave. U svakom slučaju, svaka krajnja točka trebala bi imati opis koji će objasniti što radi.

Iz njegovih dokumenata ovo su krajnje točke u Slash -ovom API -ju povezane s rupama:

DOBIJITE

DOBIJITE

OBJAVITE

POSTAVITE

OBJAVITE

Korak 4: Odredite vrstu zahtjeva

Sada kada ste pronašli pravu krajnju točku, morate odrediti vrstu zahtjeva za njeno slanje.

Postoje 4 različite vrste zahtjeva:

DOBITI

GET zahtjev je način na koji tražite od API -ja da odgovori s nečim što ima, najčešće podacima. Možete zatražiti posebne podatke o jednoj stavci ili skupini stavki na temelju krajnje točke i parametara. Ovo je ekvivalent traženju Slash -a da vam donese jednu od njegovih kostiju ili sve njegove kosti.

POST

POST zahtjev je način na koji API -u kažete da stvori nešto novo. Ovo je slično zahtjevu Slash -a da vam iskopa (stvori) novu rupu.

STAVITI

PUT zahtjev je način na koji API -u kažete da ažurira nešto što je prethodno stvoreno. Ovo je slično zahtjevu da Slash kopa dublje (ažurira) u rupu koju je iskopao.

IZBRISATI

Zahtjev za brisanjem je način na koji API -u kažete da izbriše nešto što je prethodno stvoreno. Ovo je slično zahtjevu Slash -a da prikrije (izbriše) rupu koju je prethodno iskopao.

Razmislite o ove četiri vrste. Dobivate li informacije, stvarate li novi unos, mijenjate postojeći unos ili ga brišete? Taj vam odgovor govori koja vrsta zahtjeva vam je potrebna.

Korak 5: Shvatite parametre

Mnogi zahtjevi zahtijevaju dodatne parametre. Parametri su detalji vašeg zahtjeva. Na primjer, ako želite da vam Slash donosi sve loptice koje su crvene, morate navesti boju. Ako želite da napravi novu rupu, morate mu reći gdje će je staviti i koliko duboko kopati.

API dokumentacija na koju se pozivate trebala bi imati odjeljak pod nazivom "Parametri" ili "Opcije" za svaku krajnju točku i vrstu zahtjeva. Obratite pozornost na to koji su parametri potrebni jer su neki izborni. Ako je parametar označen kao neobavezan, dokumenti mogu pružiti primjer koji je ujedno i zadani.

Slash -ovi parametri API -ja mogu izgledati otprilike ovako za dohvaćanje kuglica:

DOBIJITE

Korak 6: Formatirajte svoj zahtjev

Imamo sve potrebne podatke, samo trebamo podnijeti zahtjev!

Evo dva različita načina povezivanja na API koji ne zahtijevaju kôd. Spojimo se na Slash -ov API kako bismo dobili njegov popis lopti slanjem GET zahtjeva na

Parabola - ako se želite povezati i raditi s podacima bez koda

Parabola je web aplikacija koja vam omogućuje jednostavno povezivanje s API-jem, a zatim rad s podacima putem vizualnog alata za povlačenje i ispuštanje.