Povežite se na API -je bez koda: 8 koraka

2024 Autor: John Day | [email protected]. Zadnja izmjena: 2024-01-30 08:05

Ovaj vodič je dizajniran za ljude koji žele postići nešto što zahtijeva korištenje API -ja, ali nisu sigurni kako započeti. Već znate zašto je rad s API -jem koristan, a ovaj vodič će vam 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 softverski inženjer koji 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 servisu zajedno sa skupom odgovora koji odgovaraju zahtjevu. Michelle je istrenirala Slash -a da učini isto. Slash je dobar dječak, zna razne komande i uvijek pravilno reagira sve dok mu date zahtjev koji je naučio. Kad se dodatno uzbudi, rep mu poludi - ovo ga Michelle nije naučila vezano za API -je, to je samo zato što je ljupko štene i zaista uživa u treningu!

Korak 1: Odlučite koji vam API treba

Koje informacije tražite ili želite promijeniti?

Pokušavate li zgrabiti sve Instagram postove @dougthepug? Možda želite automatski tvitati svakome ko 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 direktno na 2. korak. 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 šta će se pojaviti. Možda ćete se iznenaditi koliko informacija postoji.

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.

Korak 2: Pronađite API dokumente

API-ji koje pružaju poznate kompanije trebaju imati detaljnu 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 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 -a), možda ćete morati zatražiti dokumentaciju od programera. Možda imaju 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 tačku

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

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

slashtheapidog.com/api/bones/{id}

ili samo

/kosti

Dokumentacija treba imati listu krajnjih tačaka. Mogu biti na najvišoj razini u dokumentima ili u odjeljku koji se naziva "referenca", "krajnje točke" ili "metode". Da biste pronašli pravu krajnju točku, potražite ime koje 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 šta radi.

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

NABAVITE

NABAVITE

POST

STAVITE

POST

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:

GET

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 informacije o jednoj stavci ili grupi 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.

POŠTA

POST zahtjev je način na koji kažete API -ju da stvori nešto novo. Ovo je slično traženju Slash -a da za vas iskopa (stvori) novu rupu.

STAVITI

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

IZBRIŠI

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, kreirate li novi unos, mijenjate postojeći unos ili ga brišete? Taj odgovor govori vam tačno 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 crvene kuglice, morate navesti boju. Ako želite da napravi novu rupu, morate mu reći gdje da je stavi i koliko duboko da kopa.

API dokumentacija na koju se pozivate trebala bi imati odjeljak pod nazivom "Parametri" ili "Opcije" za svaku krajnju točku i vrstu zahtjeva. Obratite pažnju 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 preuzimanje loptica:

NABAVITE

Korak 6: Formatirajte svoj zahtjev

Imamo sve potrebne podatke, sada samo trebamo podnijeti zahtjev!

Evo dva različita načina povezivanja na API koji ne zahtijevaju kôd. Povežimo se sa Slash -ovim API -jem kako bismo dobili njegovu listu 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.