De basis van een API‑request

Introductie tot API's in Python

Chris Ramakers

Engineering Manager

Wat zijn URL’s?

URL = Uniform Resource Locator
Het gestructureerde adres van een API‑resource
Pas de URL aan om met specifieke API‑resources te werken

http://350.5th-ave.com/unit/243

De URL ontleden

Een diagram met onderdelen van een URL: Protocol (http://), Domein (350.5th-ave.com), Poort (:80), Pad (/unit/243) en Query (?floor=77).

Protocol = het transportmiddel
Domein = het straatadres van het kantoorgebouw
Poort = de poort/deur om het gebouw binnen te gaan
Pad = de specifieke kantoorunit in het gebouw
Query = extra instructies

Queryparameters toevoegen met requests

# Voeg queryparameters toe aan de URL‑string
response = requests.get('http://350.5th-ave.com/unit/243?floor=77&elevator=True')
print(response.url)

http://350.5th-ave.com/unit/243?floor=77&elevator=True

Gebruik het argument params om queryparameters toe te voegen

# Maak een dictionary
query_params = {'floor': 77, 'elevator': True}
# Geef de dictionary door via het argument `params`
response = requests.get('http://350.5th-ave.com/unit/243', params=query_params)
print(response.url)

http://350.5th-ave.com/unit/243?floor=77&elevator=True

HTTP‑werkwoorden

Bestemming: Unit 243 van het kantoorgebouw 350 5th Ave
URL: http://350.5th-ave.com/unit/243

Acties

Werkwoord	Actie	Beschrijving
GET	Lezen	De inhoud van de brievenbus checken
POST	Maken	Een nieuw pakket in de brievenbus stoppen
PUT	Updaten	Alle pakketten vervangen door een nieuw
DELETE	Verwijderen	Alle pakketten uit de brievenbus halen

¹ Er zijn in totaal 9 HTTP‑werkwoorden, maar voor eenvoudige REST‑API’s zijn deze 4 relevant

Data versturen met POST en PUT

# GET = Een resource ophalen
response = requests.get('http://350.5th-ave.com/unit/243')

# POST = Een resource aanmaken
response = requests.post('http://350.5th-ave.com/unit/243', data={"key": "value"})
# PUT = Een bestaande resource bijwerken
response = requests.put('http://350.5th-ave.com/unit/243', data={"key": "value"})

# DELETE = Een resource verwijderen
response = requests.delete('http://350.5th-ave.com/unit/243')

Elk werkwoord heeft z’n eigen methode in het requests‑pakket
Gebruik het argument data om data mee te geven aan een POST of PUT‑request.

Laten we oefenen!

Introductie tot API's in Python