Utilizzo di Parametri URL nelle Richieste API con Requests

by theArchitect
SHARE
Utilizzo di Parametri URL nelle Richieste API con Requests
© Guida-HTML5.it

Introduzione

Quando si interagisce con le API, è comune dover inviare parametri tramite l´URL per filtrare o modificare i dati restituiti. La libreria requests di Python semplifica questo processo, permettendo di aggiungere facilmente parametri alle richieste GET. In questo tutorial, esploreremo come utilizzare i parametri URL con la libreria requests, fornendo esempi pratici e spiegazioni dettagliate.

Codice completo

import requests

# Funzione per ottenere dati da un´API utilizzando parametri URL
def get_weather(city):
    # URL dell´API per ottenere le informazioni meteo
    api_url = "http://api.openweathermap.org/data/2.5/weather"
    
    # Parametri da inviare nella richiesta
    params = {
        ´q´: city,  # Nome della città
        ´appid´: ´YOUR_API_KEY´,  # La tua chiave API
        ´units´: ´metric´  # Unità di misura (metriche)
    }
    
    # Effettua la richiesta GET
    response = requests.get(api_url, params=params)
    
    # Controlla se la richiesta ha avuto successo
    if response.status_code == 200:
        return response.json()  # Restituisce i dati in formato JSON
    else:
        return {"error": response.status_code, "message": response.text}

# Esempio di utilizzo della funzione
if __name__ == "__main__":
    city_name = "Rome"
    weather_data = get_weather(city_name)
    print(weather_data)

Spiegazione

Nel codice sopra, abbiamo definito una funzione get_weather che accetta il nome di una città come parametro. All´interno della funzione:

  • api_url: Definiamo l´URL dell´API da cui vogliamo ottenere i dati meteo.
  • params: Creiamo un dizionario contenente i parametri da inviare. In questo caso, includiamo il nome della città, la chiave API e l´unità di misura.
  • requests.get: Utilizziamo il metodo get di requests, passando l´URL e i parametri. La libreria si occupa di costruire l´URL finale per noi.
  • response.status_code: Controlliamo se la richiesta ha avuto successo (status code 200). Se sì, restituiamo i dati in formato JSON; altrimenti, restituiamo un messaggio di errore.

Infine, nel blocco if __name__ == "__main__", chiamiamo la funzione con il nome di una città e stampiamo i dati restituiti.

Best practice

  • Gestione delle chiavi API: Non inserire mai la tua chiave API direttamente nel codice. Utilizza variabili d´ambiente o file di configurazione per gestirle in modo sicuro.
  • Controllo degli errori: Implementa sempre un controllo degli errori per gestire eventuali problemi con le richieste API. Puoi utilizzare i codici di stato HTTP per identificare il tipo di errore.
  • Documentazione dell´API: Prima di utilizzare un´API, consulta sempre la sua documentazione per comprendere quali parametri sono richiesti e quali valori puoi utilizzare.
  • Limitazioni delle richieste: Alcune API hanno limiti sul numero di richieste che puoi effettuare in un certo periodo. Assicurati di rispettare queste limitazioni per evitare di essere bloccato.

Riepilogo

In questo tutorial, abbiamo appreso come utilizzare i parametri URL nelle richieste API con la libreria requests in Python. Abbiamo visto come costruire una richiesta GET, gestire i parametri e controllare gli errori. Ricorda sempre di seguire le best practice per garantire la sicurezza e l´efficienza delle tue applicazioni.

Approfondisci con risorse ufficiali

SHARE