Eerste API-verzoek versturen in Opdrachten
Om je eerste API-verzoek te versturen, maak je een URL aan die verwijst naar het "eindpunt" van de API die je wilt aanroepen en geef je die URL vervolgens door aan de taak "Haal inhoud van URL op". Tijdens de uitvoering van de opdracht wordt met deze taak het API-verzoek ingediend.
Het API-verzoek definiëren
Voor het eindpunt van het onderdeel Forecast van Dark Sky moet een URL-verzoek als volgt zijn opgemaakt:
https://api.darksky.net/forecast/[GEHEIME_SLEUTEL]/[BREEDTE],[LENGTE]
De tekst tussen rechte haken wordt vervangen door respectievelijk een API-sleutel en de locatie waarvoor je de weersverwachting wilt weten.
Zet in de app Opdrachten de API-sleutel die je van Dark Sky hebt gekregen in de eerste taak "Tekst". Deze taak wordt als een variabele doorgegeven aan de taak "URL". De waarden voor
BREEDTE
enLENGTE
zijn al ingesteld op37.8267
en-122.4233
, wat de coördinaten zijn voor Alcatraz Island in San Francisco. (Je kunt deze waarden uiteraard wijzigen.)Gebruik de taak "Haal huidige locatie op" en neem die als een magische variabele (ingesteld op 'Breedtegraad' en 'Lengtegraad') in de URL op om met de opdracht de weersverwachting voor je huidige locatie op te vragen.
Het API-verzoek uitvoeren met de taak "Haal inhoud van URL op"
In de opdrachteneditor van de Opdrachten-app stel je "Haal inhoud van URL op" in op 'Geavanceerd'.
Nu zijn de volgende opties beschikbaar voor de typen API-verzoeken die je kunt versturen:
Met
GET
kun je gegevens uit een API ophalen om deze te lezen.Met
POST
kun je nieuwe gegevens aanmaken.Met
PUT
enPATCH
kun je gegevens bijwerken door deze respectievelijk te vervangen of te wijzigen.Met
DELETE
kun je een object verwijderen dat in het URL-verzoek is opgegeven.
Voor dit voorbeeld gebruiken we een
GET
-verzoek om gegevens op te halen uit de Dark Sky-API.De taak "URL" bevat nu het verzoek en de taak "Haal inhoud van URL op" is geconfigureerd voor het ophalen van gegevens met
GET
. Je kunt het API-verzoek nu gaan versturen.Opmerking: Wanneer je de taak "Haal inhoud van URL op" instelt op
POST
,PUT
ofPATCH
, wordt er een nieuwe parameter met de naam 'Vraag om hoofdtekst' toegevoegd. Met 'Vraag om hoofdtekst' kun je bij je verzoek JSON-gegevens, een formulier of een bestand meesturen naar de API. Hierdoor kun je nieuwe gegevens handmatig of met behulp van variabelen invoeren, zodat je de gegevens naar de API kunt sturen om een vermelding aan te maken, te vervangen of aan te passen.Tik op om de opdracht te testen (via de taak "Snelle weergave" in de opdracht kun je een voorvertoning bekijken van de gegevens die door de API worden geretourneerd).
Gefeliciteerd! Je hebt je eerste API-verzoek aangemaakt met Opdrachten.
Op het eerste gezicht lijkt het alsof de API een heleboel vreemd opgemaakte tekst retourneert. Als je beter kijkt, zie je dat de tekst gegevens over de weersverwachting bevat. Deze gegevens zijn gecodeerd in JSON, wat staat voor JavaScript Object Notation.
Zie JSON gebruiken in Opdrachten voor informatie over het werken met JSON en om verder te gaan met het voorbeeld van de Dark Sky-API.