Best practice per l'utilizzo dei servizi web dell'API Address Validation

I servizi web di Google Maps Platform sono una raccolta di interfacce HTTP per i servizi Google che forniscono dati geografici per le tue applicazioni di mappe.

Questa guida descrive alcune pratiche comuni utili per configurare le richieste di servizio web e elaborare le risposte dei servizi. Consulta la guida per gli sviluppatori per la documentazione completa dell'API Address Validation.

Che cos'è un servizio web?

I servizi web di Google Maps Platform sono un'interfaccia per richiedere i dati dell'API di Maps da servizi esterni e utilizzare i dati all'interno delle applicazioni Maps. Questi servizi sono progettati per essere utilizzati in combinazione con una mappa, in conformità alle Limitazioni di licenza nei Termini di servizio di Google Maps Platform.

I servizi web delle API di Google Maps utilizzano richieste HTTP(S) a URL specifici, trasmettendo parametri URL e/o dati POST in formato JSON come argomenti per i servizi. In genere, questi servizi restituiscono i dati nel corpo della risposta in formato JSON per l'analisi e/o l'elaborazione da parte dell'applicazione.

Convalida un indirizzo inviando una richiesta POST HTTP al metodo validateAddress:

https://addressvalidation.googleapis.com/v1:validateAddress

Passa un corpo JSON alla richiesta, definendo l'indirizzo, da convalidare

Nota: tutte le applicazioni dell'API Address Validation richiedono l'autenticazione. Leggi ulteriori informazioni sulle credenziali di autenticazione.

Accesso SSL/TLS

HTTPS è obbligatorio per tutte le richieste di Google Maps Platform che utilizzano chiavi API o contengono dati utente. Le richieste effettuate tramite HTTP che contengono dati sensibili potrebbero essere rifiutate.

Creazione di un URL valido

Potresti pensare che un URL "valido" sia già evidente, ma non è così. Un URL inserito nella barra degli indirizzi di un browser, ad esempio, potrebbe contenere caratteri speciali (ad es. "上海+中國"); il browser deve tradurre internamente questi caratteri in una codifica diversa prima della trasmissione. Allo stesso modo, qualsiasi codice che genera o accetta input UTF-8 potrebbe trattare gli URL con caratteri UTF-8 come "validi", ma dovrebbe anche tradurre questi caratteri prima di inviarli a un server web. Questo processo è chiamato codifica degli URL o codifica a percentuale.

Attenzione: i browser e/o i servizi potrebbero codificare automaticamente l'URI di una richiesta prima dell'invio. Nelle API che utilizzano la firma delle richieste crittografiche, questo può potenzialmente invalidare la firma se la codifica URL modifica la richiesta dopo la firma. Per evitare questo problema, codifica sempre la stringa di query tramite URL prima di firmare la richiesta.

Caratteri speciali

Dobbiamo tradurre i caratteri speciali perché tutti gli URL devono essere conformi alla sintassi specificata dalla specifica URI (Uniform Resource Identifier). In pratica, ciò significa che gli URL devono contenere solo un sottoinsieme speciale di caratteri ASCII: i familiari simboli alfanumerici e alcuni caratteri riservati da utilizzare come caratteri di controllo all'interno degli URL. Questa tabella riassume questi caratteri:

Imposta	caratteri	Utilizzo degli URL
Alfanumerico	a b c d e f g h i j k l m n o p q r s t u v w x y z A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 0 1 2 3 4 5 9 7	Stringhe di testo, utilizzo degli schemi (http), porta (8080), ecc.
Non prenotato	- _ . ~	Stringhe di testo
Riservata	! * ' ( ) ; : @ & = + $ , / ? % # [ ]	Caratteri di controllo e/o stringhe di testo

Quando crei un URL valido, devi assicurarti che contenga solo i caratteri visualizzati nella tabella Riepilogo dei caratteri URL validi. La conformità di un URL per l'utilizzo di questo insieme di caratteri generalmente causa due problemi, uno di omissione e uno di sostituzione:

• I caratteri che vuoi gestire esistono al di fuori del set precedente. Ad esempio, i caratteri in lingue straniere come 上海+中國 devono essere codificati utilizzando i caratteri precedenti. Secondo una convenzione comune, gli spazi (che non sono consentiti negli URL) vengono spesso rappresentati utilizzando anche il carattere più '+'.
• I caratteri esistono all'interno dei set precedenti come caratteri riservati, ma devono essere utilizzati letteralmente. Ad esempio, ? viene utilizzato negli URL per indicare l'inizio della stringa di query; se vuoi utilizzare la stringa "? e i misteri", devi codificare il carattere '?'.

Tutti i caratteri da codificare nell'URL vengono codificati utilizzando un carattere '%' e un valore esadecimale di due caratteri corrispondenti al relativo carattere UTF-8. Ad esempio, 上海+中國 in UTF-8 verrebbe codificata come URL come %E4%B8%8A%E6%B5%B7%2B%E4%B8%AD%E5%9C%8B. La stringa ? and the Mysterians deve essere codificata nell'URL come %3F+and+the+Mysterians o %3F%20and%20the%20Mysterians.

Caratteri comuni che richiedono la codifica

Ecco alcuni caratteri comuni che devono essere codificati:

Carattere non sicuro	Valore codificato
Spazio	%20
"	%22
<	%3C
>	%3E
#	%23
%	%25
|	%7C

La conversione di un URL che ricevi dall'input utente a volte è difficoltosa. Ad esempio, un utente può inserire un indirizzo come "Via Roma". In genere, devi creare l'URL partendo dalle sue parti, considerando gli input utente come caratteri letterali.

Inoltre, gli URL sono limitati a 16.384 caratteri per tutti i servizi web e le API web statiche di Google Maps Platform. Per la maggior parte dei servizi, questo limite di caratteri viene raggiunto raramente. Tuttavia, tieni presente che alcuni servizi hanno diversi parametri che possono generare URL lunghi.

Uso educato delle API di Google

I client API progettati in modo errato possono applicare un carico maggiore del necessario sia su Internet sia sui server di Google. Questa sezione contiene alcune best practice per i client delle API. Seguendo queste best practice, puoi evitare che la tua applicazione venga bloccata per uso illecito involontario delle API.

Backoff esponenziale

In rari casi, potrebbe verificarsi un problema durante la gestione della tua richiesta; potresti ricevere un codice di risposta HTTP 4XX o 5XX oppure la connessione TCP potrebbe semplicemente non riuscire da qualche parte tra il client e il server di Google. Spesso vale la pena riprovare la richiesta poiché la richiesta di follow-up potrebbe avere esito positivo quando l'originale non è andato a buon fine. Tuttavia, è importante non limitarsi a eseguire ripetutamente il loop delle richieste ai server di Google. Questo comportamento di loop può sovraccaricare la rete tra il client e Google, causando problemi a molte parti.

Un approccio migliore è riprovare con un ritardo maggiore tra un tentativo e l'altro. Di solito il ritardo è aumentato di un fattore moltiplicativo a ogni tentativo, un approccio noto come backoff esponenziale.

Prendi in considerazione, ad esempio, un'applicazione che desidera inviare questa richiesta all'API Time Zone:

https://maps.googleapis.com/maps/api/timezone/json?location=39.6034810,-119.6822510&timestamp=1331161200&key=YOUR_API_KEY

Il seguente esempio Python mostra come effettuare la richiesta con backoff esponenziale:

import json
import time
import urllib.error
import urllib.parse
import urllib.request

# The maps_key defined below isn't a valid Google Maps API key.
# You need to get your own API key.
# See https://developers.google.com/maps/documentation/timezone/get-api-key
API_KEY = "YOUR_KEY_HERE"
TIMEZONE_BASE_URL = "https://maps.googleapis.com/maps/api/timezone/json"


def timezone(lat, lng, timestamp):

    # Join the parts of the URL together into one string.
    params = urllib.parse.urlencode(
        {"location": f"{lat},{lng}", "timestamp": timestamp, "key": API_KEY,}
    )
    url = f"{TIMEZONE_BASE_URL}?{params}"

    current_delay = 0.1  # Set the initial retry delay to 100ms.
    max_delay = 5  # Set the maximum retry delay to 5 seconds.

    while True:
        try:
            # Get the API response.
            response = urllib.request.urlopen(url)
        except urllib.error.URLError:
            pass  # Fall through to the retry loop.
        else:
            # If we didn't get an IOError then parse the result.
            result = json.load(response)

            if result["status"] == "OK":
                return result["timeZoneId"]
            elif result["status"] != "UNKNOWN_ERROR":
                # Many API errors cannot be fixed by a retry, e.g. INVALID_REQUEST or
                # ZERO_RESULTS. There is no point retrying these requests.
                raise Exception(result["error_message"])

        if current_delay > max_delay:
            raise Exception("Too many retry attempts.")

        print("Waiting", current_delay, "seconds before retrying.")

        time.sleep(current_delay)
        current_delay *= 2  # Increase the delay each time we retry.


if __name__ == "__main__":
    tz = timezone(39.6034810, -119.6822510, 1331161200)
    print(f"Timezone: {tz}")

Devi inoltre fare attenzione che non ci sia codice di ripetizione più in alto nella catena di chiamate dell'applicazione che porta a richieste ripetute in rapida successione.

Richieste sincronizzate

Un numero elevato di richieste sincronizzate alle API di Google può sembrare un attacco Distributed Denial of Service (DDoS) sull'infrastruttura di Google ed essere gestito di conseguenza. Per evitare questo problema, devi assicurarti che le richieste API non siano sincronizzate tra i client.

Prendiamo ad esempio un'applicazione che mostra l'ora nel fuso orario corrente. Questa applicazione probabilmente imposterà un allarme nel sistema operativo client riattivandolo all'inizio del minuto, in modo che sia possibile aggiornare l'ora visualizzata. L'applicazione non deve effettuare chiamate API nell'ambito dell'elaborazione associata a questo allarme.

Effettuare chiamate API in risposta a un allarme fisso non è un buon segno, perché le chiamate API vengono sincronizzate all'inizio del minuto, anche tra dispositivi diversi, invece di essere distribuite in modo uniforme nel tempo. Un'applicazione progettata male all'inizio di ogni minuto produrrà un picco di traffico a livelli sessanta volte normali.

Una soluzione efficace potrebbe essere quella di impostare una seconda sveglia su un orario scelto in modo casuale. Quando questo secondo allarme si attiva, l'applicazione chiama le API di cui ha bisogno e archivia i risultati. Quando l'applicazione vuole aggiornare la visualizzazione all'inizio del minuto, utilizza i risultati archiviati in precedenza anziché chiamare di nuovo l'API. Con questo approccio, le chiamate API vengono distribuite in modo uniforme nel tempo. Inoltre, le chiamate API non ritardano il rendering quando il display viene aggiornato.

A parte l'inizio del minuto, altri orari di sincronizzazione comuni in cui devi non scegliere come target sono all'inizio dell'ora e all'inizio di ogni giorno a mezzanotte.

Elaborazione risposte

Nota: poiché non è garantito il formato esatto delle singole risposte con una richiesta di servizio web (alcuni elementi potrebbero mancare o in più posizioni), non devi mai dare per scontato che il formato restituito per una determinata risposta sia lo stesso per query diverse. Devi invece elaborare la risposta e selezionare i valori appropriati tramite espressioni.

Questa sezione illustra come estrarre questi valori in modo dinamico dalle risposte del servizio web.

I servizi web di Google Maps forniscono risposte facili da capire, ma non esattamente facili da usare. Quando esegui una query, anziché visualizzare un insieme di dati, probabilmente vorrai estrarre alcuni valori specifici. In genere, vorrai analizzare le risposte dal servizio web ed estrarre solo i valori che ti interessano.

Lo schema di analisi utilizzato dipende dalla restituzione dell'output in JSON. Le risposte JSON, essendo già sotto forma di oggetti JavaScript, possono essere elaborate all'interno dello stesso codice JavaScript sul client.