Mengirim permintaan validasi alamat

Kirim permintaan validasi alamat dengan mengeluarkan permintaan POST ke salah satu endpoint berikut:

• validateAddress (REST)
• ValidateAddress (gRPC)

Permintaan Anda juga harus meneruskan isi permintaan JSON ke permintaan yang menentukan alamat yang akan divalidasi. Isi permintaan berikut berisi satu kolom dan tiga subkolom:

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"

Anda juga dapat menghilangkan locality dan menentukannya sebagai elemen dalam array addressLines:

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

Cobalah!

Kolom permintaan alamat

Isi permintaan terdiri dari satu kolom:

• address — kolom dari jenis PostalAddress, yang harus berisi setidaknya satu entri di addressLines.

Saat mengirim kolom address ke Address Validation API, Anda hanya perlu menyediakan satu kolom: addressLines. Namun, permintaan alamat paling sederhana harus berisi subkolom berikut:

• regionCode — Direkomendasikan. Ini adalah kolom opsional, tetapi jika dihilangkan, Address Validation API akan menyimpulkan wilayah dari alamat. Namun, untuk hasil terbaik, sertakan regionCode jika Anda mengetahuinya. Untuk mengetahui daftar region yang didukung, lihat region yang didukung.
• addressLines — Wajib. Array dengan alamat yang menjelaskan struktur alamat yang lebih rendah.

Lihat PostalAddress di panduan referensi.

Opsi USPS CASS™

United States Postal Service® (USPS®)¹ mengelola Coding Accuracy Support System (CASS™) untuk mendukung dan memberikan sertifikasi kepada penyedia validasi alamat.

Khusus untuk wilayah Amerika Serikat dan Puerto Riko, Anda dapat mengaktifkan pemrosesan CASS dengan menetapkan enableUspsCass ke true dalam isi permintaan. Untuk hasil terbaik saat menggunakan CASS, berikan alamat yang menyertakan jalan dan nomor jalan beserta kota, negara bagian, dan kode pos:

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

Cobalah!

API Explorer memungkinkan Anda membuat contoh permintaan sehingga Anda dapat memahami API dan opsi API.

1. Pilih ikon API, , di sisi kanan halaman.

2. Jika ingin, luaskan Tampilkan parameter standar dan tetapkan parameter fields ke mask kolom.

3. Jika ingin, edit Isi permintaan.

4. Pilih tombol Execute. Dalam dialog, pilih akun yang ingin Anda gunakan untuk membuat permintaan.

5. Di panel API Explorer, pilih ikon luaskan, , untuk meluaskan jendela API Explorer.