Prisijunkite prie API be kodo: 8 veiksmai

2024 Autorius: John Day | [email protected]. Paskutinį kartą keistas: 2024-01-30 10:45

Šis vadovas skirtas žmonėms, kurie nori ką nors pasiekti, o tam reikia naudoti API, tačiau nėra visiškai tikri, kaip pradėti. Jūs jau žinote, kodėl gebėjimas dirbti su API yra naudingas, ir šis vadovas parodys, kaip tai padaryti.

Jei tai skamba kaip jūs, jums pasisekė! Mes čia norime paaiškinti, kaip dirbti su API, kaip skaityti API dokumentus ir kaip iš tikrųjų naudoti duomenis, gaunamus iš API.

Atsivežėme draugą, kad kelionė būtų daug lengvesnė.

Susipažinkite - Slash

Slash yra žavingas, mylimas Michelle šuo (nuotrauka aukščiau). Michelle yra programinės įrangos inžinierius, kuriantis API. Michelle labai džiaugiasi savo darbu ir įkvėpimo semiasi iš savo darbo kurdama API mokydama „Slash“.

Kaip žinote, API yra komandų rinkinys, kurį vartotojas gali duoti žiniatinklio paslaugai kartu su užklausą atitinkančių atsakymų rinkiniu. Michelle išmokė Slashą daryti tą patį. Slash yra geras berniukas, žino įvairias komandas ir visada atsako teisingai, jei tik duodi jam prašymą, kad jis būtų išmokytas. Kai jis dar labiau susijaudina, jo uodega išprotėja - tai nėra kažkas, ko Michelle išmokė jį, susijusį su API, tai tik todėl, kad jis yra mylimas šuniukas ir jam labai patinka jo mokymas!

1 veiksmas: nuspręskite, kokios API jums reikia

Kokios informacijos ieškote ar norite pakeisti?

Ar bandote patraukti visus „ @dougthepug“„Instagram“įrašus? Galbūt norite automatiškai įrašyti tweet'ą visiems, kurie seka jūsų šuns twitterį (nes nors šunys nemoka kalbėti, jie turi daug ką pasakyti, mes žinome, kad Slash tikrai tai daro).

Jei jau žinote svetainę ar API, prie kurios bandote prisijungti, pereikite tiesiai prie 2 veiksmo. Jei bandote rasti duomenų, bet nežinote, nuo ko pradėti, „Google“yra jūsų draugas. Ieškokite „[dalykai, kurie jus domina] API“ir pažiūrėkite, kas pasirodo. Galbūt nustebsite, kiek informacijos yra.

Jei norite paprasto API pavyzdžio, galite naudoti tą „Michelle“, sukurtą mokant „Slash“. Jame yra keletas jo mėgstamiausių komandų, tokių kaip kamuoliukų paėmimas ir duobių kasimas. Mes jį naudosime visuose kituose mūsų pavyzdžiuose.

2 veiksmas: raskite API dokumentus

Žinomų bendrovių pateiktos API turėtų turėti išsamų jų naudojimo dokumentą.

Norėdami juos rasti, „Google“[Įterpkite įmonės] API dokumentaciją “arba„ [Įterpkite įmonę] kūrėjas “.

Rezultatai turėtų nukreipti jus į kūrėjų portalą. Ieškokite nuorodos „Dokumentai“, „Dokumentacija“, „Nuoroda“arba „Techninė nuoroda“.

Dokumentuose gali tekti ieškoti konkrečios norimos API, nes kartais gali būti daug variantų. Pavyzdžiui, „Facebook“turi atskiras API rinkodarai, skelbimams, puslapiams ir kt.

Jei API, prie kurios norite prisijungti, nėra gerai žinoma (pvz., „Slash“), gali tekti paprašyti kūrėjo pateikti dokumentus. Jie gali turėti PDF failą, kuriame yra jums reikalinga informacija, arba internetinės dokumentacijos, kuri nėra nurodyta jų svetainėje.

Jei praleidote nuorodą ankstesniame veiksme, „Slash“API dokumentus rasite čia.

3 žingsnis: raskite galutinį tašką

API dokumentai gali atrodyti bauginantys, tačiau kai žinote, ko ieškoti, jie paprastai yra gerai struktūruoti ir gana standartizuoti.

Pirmiausia reikia ieškoti tinkamo (-ų) galutinio (-ių) parametro (-ų). Turi būti vienas galutinis taškas, atitinkantis kiekvieną norimų duomenų tipą. Galutinis taškas gali atrodyti taip:

slashtheapidog.com/api/bones/{id}

arba tiesiog

/kaulai

Dokumentuose turėtų būti galutinių parametrų sąrašas. Jie gali būti aukščiausio lygio dokumentuose arba skyriuje „nuoroda“, „galiniai taškai“arba „metodai“. Norėdami rasti tinkamą galutinį tašką, ieškokite pavadinimo, atitinkančio jūsų ieškomus duomenis. Pavyzdžiui, jei norite visų Slash iškastų skylių sąrašo, /skylės tikriausiai yra tinkamos. Bet kokiu atveju kiekvienas galutinis taškas turėtų turėti aprašymą, kuris padėtų paaiškinti, ką jis daro.

Iš jo dokumentų tai yra „Slash“API galutiniai taškai, susiję su skylėmis:

GET

Gaukite

SKELBTI

ĮDĖTI

SKELBTI

4 žingsnis: nustatykite užklausos tipą

Dabar, kai radote tinkamą galutinį tašką, turite nustatyti užklausos tipą, kurį norite išsiųsti.

Yra 4 skirtingų tipų užklausos:

GET

GET užklausa yra tai, kaip jūs prašote API atsakyti tuo, ką ji turi, dažniausiai duomenimis. Galite paprašyti konkrečios informacijos apie vieną elementą ar elementų grupę, atsižvelgdami į galutinį tašką ir parametrus. Tai tolygu prašymui, kad Slashas atneštų jums vieną ar visus jo kaulus.

POST

POST užklausa yra tai, kaip jūs liepiate API sukurti kažką naujo. Tai panašu į prašymą Slash iškasti (sukurti) jums naują skylę.

PUT

PUT užklausa yra tai, kaip jūs liepiate API atnaujinti tai, kas buvo sukurta anksčiau. Tai panašu į prašymą Slasho įsigilinti (atnaujinti) į jo iškastą skylę.

IŠTRINTI

Ištrinti užklausa yra tai, kaip jūs nurodote API ištrinti tai, kas buvo sukurta anksčiau. Tai panašu į prašymą, kad Slash užmaskuotų (ištrintų) jo anksčiau iškastą skylę.

Pagalvokite apie šias keturias rūšis. Ar gaunate informaciją, kuriate naują įrašą, keičiate esamą įrašą ar jį ištrinate? Šis atsakymas tiksliai nurodo, kokio tipo užklausos jums reikia.

5 žingsnis: supraskite parametrus

Daugeliui užklausų reikia papildomų parametrų. Parametrai yra jūsų užklausos duomenys. Pavyzdžiui, jei norite, kad „Slash“atneš jums visus raudonus kamuoliukus, turite nurodyti spalvą. Jei norite, kad jis sukurtų naują skylę, turite pasakyti, kur ją įdėti ir kiek giliai kasti.

API dokumentuose, į kuriuos remiatės, turėtų būti kiekvieno parametro ir užklausos tipo skyrius „Parametrai“arba „Parinktys“. Atkreipkite dėmesį į tai, kokie parametrai yra būtini, nes kai kurie yra neprivalomi. Jei parametras pažymėtas kaip neprivalomas, dokumentai gali pateikti pavyzdį, kuris taip pat yra numatytasis.

„Slash“API parametrai gali atrodyti maždaug taip, norint gauti kamuoliukus:

Gaukite

6 žingsnis: suformatuokite savo užklausą

Turime visą reikalingą informaciją, dabar turime pateikti užklausą!

Štai du skirtingi prisijungimo prie API būdai, kuriems nereikia kodo. Prisijunkime prie „Slash“API, norėdami gauti jo kamuolių sąrašą, pateikdami GET užklausą adresu

Parabola - jei norite prisijungti prie duomenų ir dirbti su jais be kodo

„Parabola“yra žiniatinklio programa, leidžianti lengvai prisijungti prie API ir tada dirbti su duomenimis naudojant vaizdinį, vilkimo ir nuleidimo įrankį.