Listings APIListings API
Masuk
GET/api/v4/countries

Tampilkan daftar negara dan negara bagian yang didukung

Daftar negara yang didukung Listings API, negara bagian/provinsi, kode ISO untuk membuat/memperbarui lokasi, serta kolom alamat wajib atau diperiksa.

Memerlukan kunci API. Lihat Autentikasi untuk format header dan rotasi kunci.

Parameter

Endpoint ini tidak menerima parameter.

Respons

200List of supported countries, each with its states and ISO codes. The live response is trimmed here to the United States, with three of its states.
Response
{  "data": {    "supportedCountries": [      {        "databaseId": 233,        "hasCity": true,        "id": "Q291bnRyeToyMzM=",        "iso": "US",        "name": "United States",        "hasPostalCode": true,        "stateRequired": true,        "states": [          { "countryId": 233, "id": "3542", "iso": "CA", "name": "California" },          { "countryId": 233, "id": "3537", "iso": "NY", "name": "New York" },          { "countryId": 233, "id": "3524", "iso": "TX", "name": "Texas" }        ]      }    ]  }}
401Unauthenticated, missing or invalid API key.
500Internal server error.

Mengembalikan katalog lengkap negara dan wilayah administratifnya (negara bagian, provinsi, teritori) yang didukung Listings API untuk data lokasi. Setiap entri negara memuat kode ISO (iso), id Relay, databaseId numerik, array states, dan tiga penanda yang menunjukkan cara alamat lokasi diperiksa di negara tersebut. Setiap negara bagian memuat iso dan id numeriknya sendiri. Untuk negara yang tidak dibagi lagi oleh Listings API, array states yang dikembalikan kosong.

Aturan alamat per negara

Penandatruefalse
hasCitycity wajib diisi saat pembuatan (SY10126).Negara ini tidak menggunakan kota dalam sistem pengalamatannya. city yang Anda kirim akan diabaikan.
stateRequiredstateIso wajib diisi dan harus berupa salah satu states negara tersebut (SY10010).Jangan sertakan stateIso. Beberapa negara ini tetap mencantumkan states; nilai yang Anda kirim akan disimpan tanpa diperiksa.
hasPostalCodeNegara ini menggunakan kode pos. Kirim postalCode bersama alamat.Negara ini tidak memiliki sistem kode pos. Jangan sertakan postalCode.

postalCode bersifat opsional di setiap negara, tetapi kirimkan jika hasPostalCode bernilai true: beberapa platform publikasi memerlukannya untuk menempatkan pin pada peta. Nilai yang Anda kirim akan diperiksa kesesuaiannya dengan format negara tersebut (SY10014). Jika hideAddress: true disertakan pada lokasi, pemeriksaan kota dan negara bagian akan dilewati.

Kasus penggunaan: mengisi daftar pilihan alamat. Ambil data ini sekali saat aplikasi dimulai dan simpan dalam cache. Tampilkan pemilih negara dari name/iso, lalu saat negara dipilih, isi pemilih negara bagian dari states negara tersebut. Nilai iso digunakan langsung untuk mengisi kolom countryIso dan stateIso pada endpoint create-location dan update-location.

Kasus penggunaan: memvalidasi alamat sebelum Anda mengirimkannya. Sebelum memanggil create-location, periksa bahwa countryIso yang dituju ada dalam daftar ini, bahwa stateIso tercantum di bawah negara tersebut saat stateRequired bernilai true, dan bahwa city telah diisi saat hasCity bernilai true. Mendeteksi kode yang tidak didukung pada tahap ini menghasilkan pesan yang jelas di sisi klien, alih-alih 400 dari pemanggilan pembuatan. Respons lengkap berukuran besar (mencakup setiap negara yang didukung); contoh di atas dipangkas menjadi satu entri. Tidak ada parameter kueri; endpoint selalu mengembalikan seluruh data.

Request
curl -X GET 'https://listingsapi.com/api/v4/countries' \  -H "Authorization: API $LISTINGSAPI_KEY"
Run in playground