Anatomie de base d'une requête d'API

Introduction aux API en Python

Chris Ramakers

Engineering Manager

Qu'est-ce qu'une URL ?

  • URL = Uniform Resource Locator
  • L'adresse structurée d'une ressource d'API
  • Personnalisez l'URL pour cibler des ressources d'API précises
http://350.5th-ave.com/unit/243
Introduction aux API en Python

Décomposer l'URL

Schéma montrant les parties d'une URL : protocole (http://), domaine (350.5th-ave.com), port (:80), chemin (/unit/243) et requête (?floor=77).

  • Protocole = le moyen de transport
  • Domaine = l'adresse de l'immeuble de bureaux
  • Port = la porte d'entrée à utiliser
  • Chemin = le bureau précis dans l'immeuble
  • Requête = des instructions supplémentaires
Introduction aux API en Python

Ajouter des paramètres de requête avec requests

# Ajouter des paramètres de requête à la chaîne URL
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
  • Utilisez l'argument params pour ajouter des paramètres de requête
# Créer un dictionnaire
query_params = {'floor': 77, 'elevator': True}
# Transmettre le dictionnaire avec l'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
Introduction aux API en Python

Verbes HTTP

  • Destination : unité 243 de l'immeuble 350, 5e Ave
  • URL : http://350.5th-ave.com/unit/243

Actions

Verbe Action Description
GET Lire Vérifier le contenu de la boîte aux lettres
POST Créer Déposer un nouveau colis dans la boîte
PUT Mettre à jour Remplacer tous les colis par un nouveau
DELETE Supprimer Retirer tous les colis de la boîte
1 Il existe 9 verbes HTTP au total, mais pour des API REST simples, ces 4 suffisent.
Introduction aux API en Python

Envoyer des données avec POST et PUT

# GET = Récupérer une ressource
response = requests.get('http://350.5th-ave.com/unit/243')

# POST = Créer une ressource
response = requests.post('http://350.5th-ave.com/unit/243', data={"key": "value"})
# PUT = Mettre à jour une ressource existante
response = requests.put('http://350.5th-ave.com/unit/243', data={"key": "value"})

# DELETE = Supprimer une ressource
response = requests.delete('http://350.5th-ave.com/unit/243')
  • Chaque verbe a sa propre méthode dans le paquet requests
  • Utilisez l'argument data pour transmettre des données à une requête POST ou PUT.
Introduction aux API en Python

Passons à la pratique !

Introduction aux API en Python

Preparing Video For Download...