Anslut till API: er utan kod: 8 steg

2024 Författare: John Day | [email protected]. Senast ändrad: 2024-01-30 12:38

Den här guiden är utformad för personer som har något de vill åstadkomma som kräver att använda ett API, men inte är helt säkra på hur de ska komma igång. Du vet redan varför det är användbart att kunna arbeta med ett API, och den här guiden visar dig hur du gör det.

Om det låter som dig har du tur! Vi är här för att förklara hur man arbetar med API: er, hur man läser API -dokument och hur man faktiskt använder data som kommer tillbaka från ett API.

Vi har tagit med en vän för att göra resan mycket enklare.

Möt Slash

Slash är Michelles förtjusande, älskvärda hund (bilden ovan). Michelle är en mjukvaruutvecklare som bygger API: er. Michelle tycker verkligen om sitt jobb och har hämtat inspiration från sitt arbete med att bygga API: er för utbildning av Slash.

Som du kanske vet är ett API en samling kommandon som en användare kan ge till en webbtjänst tillsammans med en uppsättning svar som matchar begäran. Michelle har tränat Slash att göra precis samma sak. Slash är en bra pojke, kan en mängd olika kommandon och svarar alltid korrekt så länge du ger honom en begäran som han har fått lära sig. När han blir extra upphetsad blir hans svans galen - det här är inte något Michelle lärde honom relaterat till API: er, det är bara för att han är en älskvärd valp och verkligen trivs med sin träning!

Steg 1: Bestäm vilket API du behöver

Vilken information letar du efter eller vill du ändra?

Försöker du ta tag i alla @dougthepugs Instagram -inlägg? Kanske vill du automatiskt twittra till alla som följer din hunds twitter (för även om hundar inte kan tala har de mycket att säga, det vet vi att Slash verkligen gör).

Om du redan känner till webbplatsen eller API: et du försöker ansluta till går du direkt till steg 2. Om du försöker hitta data men inte vet var du ska börja är Google din vän. Sök efter "[saker du är intresserad av] API" och se vad som dyker upp. Du kan bli förvånad över hur mycket information som finns.

Om du vill ha ett enkelt exempel -API kan du använda det som Michelle gjorde när du tränade Slash. Den har några av hans favoritkommandon som att hämta bollar och gräva hål. Vi kommer att använda det under resten av våra exempel.

Steg 2: Hitta API -dokumenten

API: er från välkända företag bör ha grundlig dokumentation om hur de används.

För att hitta dessa, googla "[Insert Company] API -dokumentation" eller "[Insert Company] utvecklare".

Resultaten bör ta dig till utvecklarportalen. Leta efter en länk som säger "Dokument", "Dokumentation", "Referens" eller "Teknisk referens".

I dokumenten kan du behöva leta efter det specifika API du vill ha, eftersom det ibland kan finnas många alternativ. Facebook har till exempel separata API: er för marknadsföring, annonser, sidor med mera.

Om API: et du vill ansluta till inte är välkänt (som Slash) kan du behöva be utvecklaren om dokumentation. De kan ha en PDF -fil som innehåller den information du behöver eller onlinedokumentation som inte finns med på deras webbplats.

Om du missade länken i föregående steg kan du hitta Slashs API -dokument här.

Steg 3: Hitta slutpunkten

API -dokument kan se skrämmande ut, men när du vet vad du ska leta efter är de vanligtvis välstrukturerade och ganska standardiserade.

Det första du ska leta efter är lämpliga slutpunkter. Det bör finnas en slutpunkt som motsvarar varje typ av data du vill ha. En slutpunkt kan se ut så här:

slashtheapidog.com/api/bones/{id}

eller bara

/ben

Dokumentationen ska ha en lista över slutpunkter. De kan vara högsta nivå i dokumenten eller under ett avsnitt som kallas "referens", "slutpunkter" eller "metoder". För att hitta rätt slutpunkt, leta efter namnet som motsvarar den data du letar efter. Till exempel, om du vill ha en lista över alla hål som Slash har grävt, är /hål förmodligen det rätta. I varje fall bör varje slutpunkt ha en beskrivning för att förklara vad den gör.

Från hans dokument är det här slutpunkterna i Slashs API relaterade till hål:

Hämta

Hämta

POST

SÄTT

POST

Steg 4: Bestäm din begäranstyp

Nu när du har hittat rätt slutpunkt måste du bestämma vilken typ av förfrågan som ska skickas.

Det finns 4 olika typer av förfrågningar:

SKAFFA SIG

En GET -begäran är hur du ber API: et att svara med något som det har, oftast data. Du kan be om specifik information om ett objekt eller en grupp objekt baserat på slutpunkten och parametrarna. Detta motsvarar att be Slash att ge dig ett av hans ben eller alla hans ben.

POSTA

En POST -begäran är hur du säger till API: et att skapa något nytt. Detta liknar att be Slash att gräva (skapa) ett nytt hål åt dig.

SÄTTA

En PUT -begäran är hur du säger till API: et att uppdatera något som tidigare skapades. Detta liknar att be Slash att gräva djupare (uppdatera) i hålet han grävde.

RADERA

En DELETE -begäran är hur du säger till API: et att ta bort något som tidigare skapats. Detta liknar att be Slash att täcka (radera) ett hål han tidigare grävde.

Tänk på dessa fyra typer. Får du information, skapar en ny post, ändrar en befintlig post eller raderar du en? Det svaret berättar exakt vilken typ av förfrågan du behöver.

Steg 5: Förstå parametrarna

Många förfrågningar kräver ytterligare parametrar. Parametrar är detaljerna i din begäran. Om du till exempel vill att Slash ska ge dig alla bollar som är röda måste du ange färgen. Om du vill att han ska skapa ett nytt hål måste du berätta för honom var du ska lägga det och hur djupt du ska gräva.

API -dokumentationen du refererar till bör ha ett avsnitt som heter "Parametrar" eller "Alternativ" för varje slutpunkt och förfrågningstyp. Var uppmärksam på vilka parametrar som krävs eftersom vissa är valfria. Om en parameter är markerad som valfri kan dokumenten ge ett exempel som också är standard.

Slashs API -parametrar kan se ut ungefär så här för att hämta bollar:

Hämta

Steg 6: Formatera din begäran

Vi har all information vi behöver, nu behöver vi bara göra förfrågan!

Här är två olika sätt att ansluta till ett API som inte kräver någon kod. Låt oss ansluta till Slashs API för att få hans lista över bollar genom att göra en GET -begäran till

Parabel - om du vill ansluta till och arbeta med data utan kod

Parabola är en webbapp som låter dig enkelt ansluta till API: er och sedan arbeta med data genom ett visuellt, dra-och-släpp-verktyg.