Wysyłanie prośby o weryfikację adresu

Wyślij prośbę o weryfikację adresu, wysyłając żądanie POST do jednego z następujące punkty końcowe:

• validateAddress (REST),
• ValidateAddress (gRPC)

Żądanie powinno również przekazywać treść żądania JSON do żądania, które wskazuje adres do weryfikacji. Poniższa treść żądania zawiera 1 pole oraz 3 pola podrzędne:

curl -X POST -d '{
  "address": {
    "regionCode": "US",
    "locality": "Mountain View",
    "addressLines": ["1600 Amphitheatre Pkwy"]
  }
}' \
-H 'Content-Type: application/json' \
"https://addressvalidation.googleapis.com/v1:validateAddress?key=API_KEY"

Możesz też pominąć element locality i podać go jako element tablicy addressLines:

{
  "address": {
    "regionCode": "US",
    "addressLines": ["1600 Amphitheatre Pkwy", "Mountain View, CA, 94043"]
  },
}

Wypróbuj

Pola żądania adresu

Treść żądania składa się z 1 pola:

• address – pole typu PostalAddress, które musi zawierać co najmniej 1 element w polu addressLines.

Wysyłając pole address do interfejsu Address Validation API, potrzebujesz tylko podaj jedno pole: addressLines. Jednak najprostsze żądanie adresu powinien zawierać następujące pola podrzędne:

• regionCode – zalecane. To pole jest opcjonalne, ale w przypadku jego pominięcia Interfejs API do weryfikacji adresu określa region na podstawie adresu. Jednak uwzględnij regionCode, jeśli go znasz. Listę obsługiwanych regionów znajdziesz w sekcji obsługiwane regiony.
• addressLines – wymagane. Tablica z adresami opisującymi dolną wartość w strukturze adresu.

Opcja USPS CASSTM

Urząd Pocztowy Stanów Zjednoczonych (USPS®)¹ zarządza Systemu wsparcia dokładności kodowania (CASSTM) do obsługi i certyfikowania dostawców weryfikacji adresów.

Tylko w przypadku Stanów Zjednoczonych i regionów PR możesz włączyć przetwarzanie CASS, ustawiając enableUspsCass do true w treści żądania. Aby uzyskać najlepsze rezultaty podczas używania funkcji CASS podaj adres zawierający ulicę i numer domu, a także miasto, województwo i kod pocztowy:

{
  "address": {
    "regionCode": "US",
    "locality": "Mountain View",
    "administrativeArea": "CA",
    "postalCode": "94043",
    "addressLines": ["1600 Amphitheatre Pkwy"]
  },
  "enableUspsCass": true
}

Wypróbuj

API Explorer umożliwia wysyłanie przykładowych żądań, aby zapoznać się z interfejsem API i jego opcjami.

1. Kliknij ikonę interfejsu API . w prawej części strony.

2. Opcjonalnie rozwiń opcję Pokaż parametry standardowe i ustaw fields do pola .

3. Opcjonalnie możesz zmienić treść prośby.

4. Kliknij przycisk Wykonaj. W oknie wybierz konto, którego którego chcesz użyć do przesłania żądania.

5. W panelu Eksplorator API kliknij ikonę rozwijania. , aby rozwinąć okno Eksploratora interfejsów API.