Eerste API-verzoek versturen in Opdrachten op de iPhone of iPad
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 Typicode moet een URL-verzoek de volgende structuur hebben:
https://jsonplaceholder.typicode.com/[INFORMATIEBRON]
De tekst tussen haken is de informatiebron waartoe je toegang wilt. Typicode biedt veel verschillende voorbeelden voor het testen van verzoeken. In dit voorbeeld wordt https://jsonplaceholder.typicode.com/users gebruikt om een lijst met gebruikers op te vragen.
Voeg in de Opdrachten-app op je iOS- of iPadOS-apparaat het verzoek aan de URL toe.
Het verzoek
userszal een lijst met gebruikers retourneren.Je kunt de zoekresultaten beperken door een specifieke gebruiker op te geven aan de hand van zijn of haar ID:
https://jsonplaceholder.typicode.com/users/6. Hiermee wordt de gebruiker met ID 6 geretourneerd.In de meeste API's zijn query's met de volgende structuur toegestaan:
https://jsonplaceholder.typicode.com/users?username=Bram. Het vraagteken "?" vormt het begin van de query, waarmee met sleutel-waardeparen naar onderdelen wordt gezocht. In dit voorbeeld wordt met de query?username=Bramgezocht naar een gebruiker met de gebruikersnaam "Bram".Raadpleeg de documentatie van de API voor ondersteunde zoekopdrachten en query's.
Het API-verzoek uitvoeren met de taak 'Haal inhoud van URL op'
Tik in de Opdrachten-app op je iOS- of iPadOS-apparaat op 'Toon meer' in de taak 'Haal inhoud van URL op'.
Nu zijn de volgende opties beschikbaar voor de typen API-verzoeken die je kunt versturen:
Met
GETkun je gegevens ophalen.Met
POSTkun je nieuwe gegevens aanmaken.Met
PUTkun je gegevens bijwerken door ze te vervangen.Met
PATCHkun je gegevens bijwerken door ze te wijzigen.Met
DELETEkun 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 Typicode-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,PUTofPATCH, 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.
Op het eerste gezicht lijkt het alsof de API een onoverzichtelijke tekstbrij retourneert. Deze gegevens zijn gecodeerd in JSON, wat staat voor JavaScript Object Notation.
Zie JSON gebruiken in Opdrachten op de iPhone en iPad voor informatie over het werken met JSON en om verder te gaan met het voorbeeld van de Typicode-API.