Pripojenie k rozhraniam API bez kódu: 8 krokov

2025 Autor: John Day | [email protected]. Naposledy zmenené: 2025-01-23 15:05

Táto príručka je určená ľuďom, ktorí chcú dosiahnuť niečo, čo vyžaduje použitie rozhrania API, ale nie sú si istí, ako začať. Už viete, prečo je užitočné pracovať s API, a táto príručka vám ukáže, ako na to.

Ak sa vám to páči, máte šťastie! Sme tu, aby sme vám vysvetlili, ako pracovať s rozhraniami API, ako čítať dokumenty API a ako skutočne používať údaje prichádzajúce z rozhrania API.

Vzali sme so sebou priateľa, aby nám cestu veľmi uľahčil.

Zoznámte sa so Slashom

Slash je Michellein rozkošný a milý pes (na obrázku vyššie). Michelle je softvérová inžinierka, ktorá vytvára API. Michelle ju práca veľmi baví a pri výcviku Slasha sa inšpirovala svojimi API na budovanie práce.

Ako možno viete, API je zbierka príkazov, ktoré môže používateľ zadať webovej službe, spolu so sadou odpovedí, ktoré sa zhodujú s požiadavkou. Michelle vycvičila Slasha, aby urobil to isté. Slash je dobrý chlapec, ovláda rôzne príkazy a vždy reaguje správne, pokiaľ mu dáte žiadosť, ktorú ho naučili. Keď je extra vzrušený, jeho chvost sa zblázni - to nie je niečo, čo ho Michelle naučila v súvislosti s API, je to len preto, že je milé šteniatko a výcvik ho naozaj baví!

Krok 1: Rozhodnite sa, aké API potrebujete

Aké informácie hľadáte alebo chcete zmeniť?

Pokúšate sa uchopiť všetky príspevky používateľa @dougthepug na Instagrame? Možno chcete automaticky tweetovať každému, kto sleduje twitter vášho psa (pretože napriek tomu, že psy nevedia hovoriť, majú čo povedať, vieme, že Slash určite áno).

Ak už poznáte web alebo API, ku ktorému sa pokúšate pripojiť, prejdite priamo na krok 2. Ak sa pokúšate nájsť údaje, ale nie ste si istí, kde začať, Google je váš priateľ. Vyhľadajte „API [veci, ktoré vás zaujímajú]“a uvidíte, čo sa stane. Možno budete prekvapení, koľko informácií tam je.

Ak by ste chceli jednoduchý príklad rozhrania API, môžete použiť to, ktoré vytvorila Michelle počas školenia Slash. Má niektoré z jeho obľúbených príkazov, ako je získavanie loptičiek a kopanie dier. Budeme ho používať vo zvyšku našich príkladov.

Krok 2: Nájdite dokumenty API

Rozhrania API poskytované známymi spoločnosťami by mali mať dôkladnú dokumentáciu o ich použití.

Ak ich chcete nájsť, vygooglite „dokumentáciu rozhrania API [Vložiť spoločnosť] alebo„ Vývojár [Vložiť spoločnosť] “.

Výsledky by vás mali priviesť na portál pre vývojárov. Vyhľadajte odkaz s textom „Dokumenty“, „Dokumentácia“, „Referencia“alebo „Technická referencia“.

V dokumentoch budete možno musieť hľadať konkrétne požadované API, pretože niekedy môže byť veľa možností. Facebook má napríklad samostatné API pre marketing, reklamy, stránky a ďalšie.

Ak API, ku ktorému sa chcete pripojiť, nie je dostatočne známe (ako napríklad Slash), možno budete musieť vývojára požiadať o dokumentáciu. Môžu mať súbor PDF obsahujúci potrebné informácie alebo online dokumentáciu, ktorá nie je uvedená na ich webových stránkach.

Ak ste v predchádzajúcom kroku zmeškali odkaz, dokumenty Slash o API nájdete tu.

Krok 3: Nájdite koncový bod

Dokumenty API môžu vyzerať skľučujúco, ale keď viete, čo hľadať, sú zvyčajne dobre štruktúrované a štandardizované.

Prvá vec, ktorú treba hľadať, je príslušný koncový bod (-y). Mal by existovať jeden koncový bod zodpovedajúci každému typu požadovaných údajov. Koncový bod môže vyzerať takto:

slashtheapidog.com/api/bones/{id}

alebo len tak

/kosti

Dokumentácia by mala mať zoznam koncových bodov. Môžu byť na najvyššej úrovni v dokumentoch alebo v sekcii s názvom „referencie“, „koncové body“alebo „metódy“. Ak chcete nájsť správny koncový bod, hľadajte názov, ktorý zodpovedá údajom, ktoré hľadáte. Ak napríklad chcete zoznam všetkých dier, ktoré Slash vykopal, /diery je pravdepodobne ten pravý. V každom prípade by každý koncový bod mal mať popis, ktorý pomôže vysvetliť, čo robí.

Z jeho dokumentov sú to koncové body v Slashovom API súvisiace s dierami:

ZÍSKAJTE

ZÍSKAJTE

POST

UVEĎTE

POST

Krok 4: Určte typ svojej žiadosti

Teraz, keď ste našli správny koncový bod, musíte určiť typ žiadosti o jej odoslanie.

Existujú 4 rôzne typy žiadostí:

ZÍSKAJTE

Požiadavka GET je spôsob, akým požiadate API, aby odpovedalo niečím, čo má, najčastejšie údajmi. Môžete požiadať o konkrétne informácie o jednej položke alebo skupine položiek na základe koncového bodu a parametrov. To je ekvivalent toho, že požiadate Slasha, aby vám priniesol jednu z jeho kostí alebo všetky jeho kosti.

POST

Požiadavka POST je to, ako poviete API, aby vytvorilo niečo nové. Je to podobné, ako keby ste požiadali Slasha, aby vám vykopal (vytvoril) novú dieru.

VLOŽTE

Požiadavka PUT je spôsob, akým poviete API, aby aktualizovalo niečo, čo bolo predtým vytvorené. Je to podobné, ako požiadať Slasha, aby sa hlbšie (aktualizoval) do diery, ktorú vykopal.

VYMAZAŤ

Požiadavka DELETE je spôsob, akým API poviete, aby odstránil niečo, čo bolo predtým vytvorené. Je to podobné, ako keď požiadate Slasha, aby zakryl (vymazal) dieru, ktorú predtým vykopal.

Zamyslite sa nad týmito štyrmi druhmi. Získate informácie, vytvoríte nový záznam, zmeníte existujúci záznam alebo ho odstránite? Táto odpoveď vám presne povie, aký typ žiadosti potrebujete.

Krok 5: Pochopte parametre

Mnoho požiadaviek vyžaduje dodatočné parametre. Parametre sú podrobnosti o vašej požiadavke. Ak napríklad chcete, aby vám Slash priniesol všetky loptičky, ktoré sú červené, musíte zadať farbu. Ak chcete, aby vytvoril novú dieru, musíte mu povedať, kam ju dať a ako hlboko kopať.

Dokumentácia API, na ktorú odkazujete, by mala mať sekciu s názvom „Parametre“alebo „Možnosti“pre každý koncový bod a typ požiadavky. Dávajte pozor na to, ktoré parametre sú požadované, pretože niektoré sú voliteľné. Ak je parameter označený ako voliteľný, dokumenty môžu poskytnúť príklad, ktorý je tiež predvolený.

Parametre rozhrania Slash API môžu pri získavaní loptičiek vyzerať asi takto:

ZÍSKAJTE

Krok 6: Naformátujte svoju žiadosť

Máme všetky potrebné informácie, teraz stačí podať žiadosť!

Tu sú dva rôzne spôsoby pripojenia k rozhraniu API, ktoré nevyžadujú žiadny kód. Pripojme sa k rozhraniu Slash API a získame jeho zoznam loptičiek odoslaním požiadavky GET na

Parabola - ak sa chcete pripojiť k dátam a pracovať s nimi bez kódu

Parabola je webová aplikácia, ktorá vám umožňuje jednoduché pripojenie k rozhraniam API a prácu s údajmi pomocou vizuálneho nástroja typu drag-and-drop.