Koble til APIer uten kode: 8 trinn

2025 Forfatter: John Day | [email protected]. Sist endret: 2025-01-23 15:02

Denne guiden er designet for folk som har noe de vil oppnå som krever bruk av et API, men som ikke er helt sikre på hvordan de skal komme i gang. Du vet allerede hvorfor det er nyttig å kunne jobbe med et API, og denne guiden viser deg hvordan du gjør det.

Hvis det høres ut som deg, har du lykke til! Vi er her for å forklare hvordan du arbeider med APIer, hvordan du leser API -dokumenter og hvordan du faktisk bruker dataene som kommer tilbake fra et API.

Vi har tatt med en venn for å gjøre reisen mye enklere.

Møt Slash

Slash er Michels søte, kjærlige hund (bildet over). Michelle er en programvareingeniør som bygger APIer. Michelle trives veldig godt i jobben sin og har hentet inspirasjon fra arbeidet med å bygge API -er i trening av Slash.

Som du kanskje vet, er en API en samling kommandoer en bruker kan gi til en webtjeneste sammen med et sett med svar som samsvarer med forespørselen. Michelle har trent Slash til å gjøre akkurat det samme. Slash er en god gutt, kan en rekke kommandoer og svarer alltid riktig så lenge du gir ham en forespørsel han har blitt lært. Når han blir ekstra begeistret, blir halen gal - dette er ikke noe Michelle lærte ham knyttet til APIer, det er bare fordi han er en kjærlig valp og virkelig trives!

Trinn 1: Bestem hvilket API du trenger

Hvilken informasjon leter du etter, eller vil du endre?

Prøver du å få tak i alle @dougthepugs Instagram -innlegg? Kanskje du vil tweet automatisk til alle som følger hundens twitter (for selv om hunder ikke kan snakke, har de mye å si, vi vet at Slash sikkert gjør det).

Hvis du allerede kjenner nettstedet eller API -et du prøver å koble til, kan du gå direkte til trinn 2. Hvis du prøver å finne data, men ikke er sikker på hvor du skal begynne, er Google vennen din. Søk etter "[ting du er interessert i] API" og se hva som kommer opp. Du kan bli overrasket over hvor mye informasjon som finnes.

Hvis du vil ha et enkelt eksempel -API, kan du bruke det Michelle laget mens du trente Slash. Den har noen av hans favorittkommandoer som å hente baller og grave hull. Vi kommer til å bruke det gjennom resten av eksemplene våre.

Trinn 2: Finn API -dokumentene

APIer fra kjente selskaper bør ha grundig dokumentasjon om hvordan de skal brukes.

For å finne disse, google "[Sett inn selskap] API -dokumentasjon" eller "[Sett inn selskap] utvikler".

Resultatene bør ta deg til utviklerportalen. Se etter en lenke som sier "Dokumenter", "Dokumentasjon", "Referanse" eller "Teknisk referanse".

I dokumentene må du kanskje lete etter den spesifikke API -en du vil ha, noen ganger kan det være mange alternativer. Facebook har for eksempel separate APIer for markedsføring, annonser, sider og mer.

Hvis API -en du vil koble til ikke er godt kjent (som Slash), må du kanskje be utvikleren om dokumentasjon. De kan ha en PDF som inneholder informasjonen du trenger eller online dokumentasjon som ikke er oppført på nettstedet deres.

Hvis du savnet lenken i forrige trinn, finner du Slashs API -dokumenter her.

Trinn 3: Finn endepunktet

API -dokumenter kan se skremmende ut, men når du vet hva du skal se etter, er de vanligvis godt strukturert og ganske standardiserte.

Det første du må se etter er de riktige endepunktene. Det bør være ett endepunkt som tilsvarer hver type data du vil ha. Et endepunkt kan se slik ut:

slashtheapidog.com/api/bones/{id}

eller bare

/bein

Dokumentasjonen skal ha en liste over endepunkter. De kan være på toppnivå i dokumentene eller under en seksjon kalt "referanse", "endepunkter" eller "metoder". For å finne det riktige endepunktet, se etter navnet som samsvarer med dataene du leter etter. For eksempel, hvis du vil ha en liste over alle hullene Slash har gravd, er /hull sannsynligvis det riktige. Uansett bør hvert endepunkt ha en beskrivelse for å forklare hva det gjør.

Fra hans dokumenter er dette endepunktene i Slashs API knyttet til hull:

FÅ

FÅ

POST

PUT

POST

Trinn 4: Bestem forespørselstypen

Nå som du har funnet det riktige endepunktet, må du bestemme typen forespørsel for å sende det.

Det er 4 forskjellige typer forespørsler:

FÅ

En GET -forespørsel er hvordan du ber API -en om å svare med noe den har, oftest data. Du kan be om spesifikk informasjon om ett element eller en gruppe elementer basert på endepunkt og parametere. Dette tilsvarer å be Slash om å gi deg et av beinene eller alle beinene hans.

POST

En POST -forespørsel er hvordan du forteller APIen om å lage noe nytt. Dette ligner på å be Slash om å grave (lage) et nytt hull for deg.

SETTE

En PUT -forespørsel er hvordan du forteller APIen om å oppdatere noe som tidligere ble opprettet. Dette ligner på å be Slash om å grave dypere (oppdatering) i hullet han gravde.

SLETT

En SLETT -forespørsel er hvordan du forteller APIen om å slette noe som tidligere ble opprettet. Dette ligner på å be Slash om å dekke over (slette) et hull han tidligere har gravd.

Tenk på disse fire typene. Får du informasjon, oppretter en ny oppføring, endrer en eksisterende oppføring eller sletter du den? Det svaret forteller deg nøyaktig hvilken type forespørsel du trenger.

Trinn 5: Forstå parameterne

Mange forespørsler krever ytterligere parametere. Parametere er detaljene i forespørselen din. For eksempel, hvis du vil at Slash skal gi deg alle ballene som er røde, må du spesifisere fargen. Hvis du vil at han skal lage et nytt hull, må du fortelle ham hvor du skal legge det og hvor dypt du skal grave.

API -dokumentasjonen du refererer til, bør ha en seksjon kalt "Parametere" eller "Alternativer" for hvert endepunkt og forespørselstype. Vær oppmerksom på hvilke parametere som kreves, da noen er valgfrie. Hvis en parameter er merket som valgfri, kan dokumentene gi et eksempel som også er standard.

Slashs API -parametere kan se slik ut for å hente baller:

FÅ

Trinn 6: Formater forespørselen din

Vi har all informasjonen vi trenger, nå trenger vi bare å sende forespørselen!

Her er to forskjellige måter å koble til et API som ikke krever kode. La oss koble til Slashs API for å få listen over baller ved å sende en GET -forespørsel til

Parabel - hvis du vil koble til og jobbe med data uten kode

Parabola er en webapp som lar deg enkelt koble til APIer og deretter jobbe med dataene gjennom et visuelt, dra og slipp-verktøy.