Verbinding maken met API's zonder code: 8 stappen

2024 Auteur: John Day | [email protected]. Laatst gewijzigd: 2024-01-30 11:15

Deze handleiding is bedoeld voor mensen die iets willen bereiken waarvoor ze een API nodig hebben, maar niet helemaal zeker weten hoe ze moeten beginnen. Je weet al waarom het handig is om met een API te werken, en deze handleiding laat je zien hoe je dat doet.

Als dat klinkt zoals jij, heb je geluk! We zijn hier om uit te leggen hoe u met API's werkt, hoe u API-documenten leest en hoe u de gegevens die uit een API komen, daadwerkelijk gebruikt.

We hebben een vriend meegenomen om de reis veel gemakkelijker te maken.

Maak kennis met Slash

Slash is Michelle's schattige, lieve hond (hierboven afgebeeld). Michelle is een software engineer die API's bouwt. Michelle heeft echt plezier in haar werk en heeft zich laten inspireren door haar werk met het bouwen van API's bij het trainen van Slash.

Zoals u wellicht weet, is een API een verzameling opdrachten die een gebruiker aan een webservice kan geven, samen met een reeks antwoorden die overeenkomen met het verzoek. Michelle heeft Slash getraind om precies hetzelfde te doen. Slash is een brave jongen, kent verschillende commando's en reageert altijd correct zolang je hem een verzoek geeft dat hem is geleerd. Als hij extra opgewonden raakt, wordt zijn staart gek - dit is niet iets wat Michelle hem heeft geleerd met betrekking tot API's, het is gewoon omdat hij een lieve pup is en echt van zijn training geniet!

Stap 1: Bepaal welke API u nodig heeft

Welke informatie zoekt u of wilt u wijzigen?

Probeer je alle Instagram-berichten van @dougthepug te pakken? Misschien wil je automatisch tweeten naar iedereen die de twitter van je hond volgt (want hoewel honden niet kunnen praten, hebben ze veel te zeggen, we weten dat Slash dat zeker doet).

Als u de site of API waarmee u verbinding probeert te maken al kent, gaat u direct naar stap 2. Als u gegevens probeert te vinden, maar niet zeker weet waar u moet beginnen, is Google uw vriend. Zoek naar "[dingen waarin u geïnteresseerd bent] API" en kijk wat er naar boven komt. Je zult er versteld van staan hoeveel informatie er is.

Als je een eenvoudige voorbeeld-API wilt, kun je degene gebruiken die Michelle heeft gemaakt tijdens het trainen van Slash. Het heeft enkele van zijn favoriete commando's, zoals ballen ophalen en gaten graven. We zullen het in de rest van onze voorbeelden gebruiken.

Stap 2: Zoek de API-documenten

API's die door bekende bedrijven worden geleverd, moeten grondige documentatie hebben over het gebruik ervan.

Om deze te vinden, google "[Insert Company] API-documentatie" of "[Insert Company] developer".

De resultaten zouden u naar de ontwikkelaarsportal moeten brengen. Zoek naar een link met de tekst "Documenten", "Documentatie", "Referentie" of "Technische referentie".

In de documenten moet u mogelijk zoeken naar de specifieke API die u wilt, omdat er soms veel opties kunnen zijn. Facebook heeft bijvoorbeeld afzonderlijke API's voor marketing, advertenties, pagina's en meer.

Als de API waarmee u verbinding wilt maken niet goed bekend is (zoals die van Slash), moet u mogelijk de ontwikkelaar om documentatie vragen. Ze hebben mogelijk een PDF met de informatie die u nodig hebt of online documentatie die niet op hun website staat.

Als je de link in de vorige stap hebt gemist, zijn de API-documenten van Slash hier te vinden.

Stap 3: Zoek het eindpunt

API-documenten zien er misschien ontmoedigend uit, maar als je eenmaal weet waar je op moet letten, zijn ze meestal goed gestructureerd en behoorlijk gestandaardiseerd.

Het eerste waar u naar moet zoeken, zijn de juiste eindpunt(en). Er moet één eindpunt zijn dat overeenkomt met elk type gegevens dat u wilt. Een eindpunt kan er als volgt uitzien:

slashtheapidog.com/api/bones/{id}

of gewoon

/botten

De documentatie moet een lijst met eindpunten bevatten. Ze kunnen op het hoogste niveau in de documenten staan of onder een sectie met de naam 'referentie', 'eindpunten' of 'methoden'. Om het juiste eindpunt te vinden, zoekt u naar de naam die overeenkomt met de gegevens die u zoekt. Als u bijvoorbeeld een lijst wilt van alle gaten die Slash heeft gegraven, is /holes waarschijnlijk de juiste. In elk geval moet elk eindpunt een beschrijving hebben om uit te leggen wat het doet.

Uit zijn documenten zijn dit de eindpunten in de API van Slash met betrekking tot gaten:

KRIJG

KRIJG

POST

ZET

POST

Stap 4: Bepaal uw verzoektype

Nu u het juiste eindpunt hebt gevonden, moet u het type verzoek bepalen om het te verzenden.

Er zijn 4 verschillende soorten verzoeken:

KRIJGEN

Een GET-verzoek is hoe u de API vraagt om te reageren met iets dat het heeft, meestal gegevens. U kunt specifieke informatie opvragen over één item of een groep items op basis van het eindpunt en de parameters. Dit is hetzelfde als Slash vragen om je een van zijn botten of al zijn botten te brengen.

NA

Een POST-verzoek is hoe u de API vertelt iets nieuws te maken. Dit is vergelijkbaar met het vragen aan Slash om een nieuw gat voor je te graven (creëren).

LEGGEN

Een PUT-verzoek is hoe u de API vertelt iets bij te werken dat eerder is gemaakt. Dit is vergelijkbaar met het vragen aan Slash om dieper (bijwerken) te graven in het gat dat hij heeft gegraven.

VERWIJDEREN

Een DELETE-verzoek is hoe u de API vertelt iets te verwijderen dat eerder is gemaakt. Dit is vergelijkbaar met het vragen aan Slash om een eerder gegraven gat te verdoezelen (verwijderen).

Denk aan deze vier soorten. Krijgt u informatie, maakt u een nieuw item aan, wijzigt u een bestaand item of verwijdert u er een? Dat antwoord vertelt u precies welk verzoektype u nodig heeft.

Stap 5: Begrijp de parameters

Veel verzoeken vereisen aanvullende parameters. Parameters zijn de details van uw aanvraag. Als u bijvoorbeeld wilt dat Slash u alle rode ballen brengt, moet u de kleur specificeren. Als je wilt dat hij een nieuw gat maakt, moet je hem vertellen waar hij het moet plaatsen en hoe diep hij moet graven.

De API-documentatie waarnaar u verwijst, moet een sectie hebben met de naam "Parameters" of "Opties" voor elk eindpunt en aanvraagtype. Let op welke parameters vereist zijn, sommige zijn optioneel. Als een parameter is gemarkeerd als optioneel, kunnen de documenten een voorbeeld geven dat ook de standaard is.

De API-parameters van Slash kunnen er ongeveer zo uitzien voor het ophalen van ballen:

KRIJG

Stap 6: Formatteer uw verzoek

We hebben alle informatie die we nodig hebben, nu hoeven we alleen nog maar het verzoek in te dienen!

Hier zijn twee verschillende manieren om verbinding te maken met een API waarvoor geen code nodig is. Laten we verbinding maken met de API van Slash om zijn lijst met ballen te krijgen door een GET-verzoek in te dienen op

Parabool - als u verbinding wilt maken met en wilt werken met gegevens zonder code

Parabola is een web-app waarmee u eenvoudig verbinding kunt maken met API's en vervolgens met de gegevens kunt werken via een visuele tool met slepen en neerzetten.