Listings APIListings API
Oturum aç
GET/api/v4/countries

Desteklenen ülkeleri ve eyaletleri listeleme

Listings API'nin desteklediği tüm ülkeleri, eyalet/illeri, konum oluşturma/güncelleme ISO kodlarını ve zorunlu veya denetlenen adres alanlarını döndürür.

API anahtarı gerektirir. Başlık biçimi ve anahtar yenileme için Kimlik doğrulama bölümüne bakın.

Parametreler

Bu uç nokta parametre almaz.

Yanıtlar

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.

Listings API tarafından konum verileri için desteklenen ülkelerin ve bunların idari alt bölümlerinin (eyaletler, iller, bölgeler) tam kataloğunu döndürür. Her ülke kaydı, ülkenin ISO kodunu (iso), bir Relay id değerini, sayısal bir databaseId değerini, bir states dizisini ve o ülkede bir konumun adresinin nasıl denetlendiğini belirten üç bayrağı içerir. Her eyaletin kendine ait bir iso değeri ve sayısal bir id değeri vardır. Listings API tarafından alt bölümlere ayrılmayan ülkeler için boş bir states dizisi döndürülür.

Ülkelere göre adres kuralları

Bayraktruefalse
hasCityOluşturma sırasında city zorunludur (SY10126).Ülkede şehir düzeyinde adresleme yoktur. Gönderdiğiniz city değeri atılır.
stateRequiredstateIso zorunludur ve ülkenin states değerlerinden biri olmalıdır (SY10010).stateIso alanını göndermeyin. Bu ülkelerin bazılarında yine de states listelenir; gönderdiğiniz değer denetlenmeden saklanır.
hasPostalCodeÜlkede posta kodları kullanılır. Adresle birlikte postalCode alanını gönderin.Ülkede posta kodu sistemi yoktur. postalCode alanını göndermeyin.

postalCode her ülkede isteğe bağlıdır, ancak hasPostalCode değerinin true olduğu her durumda bu alanı gönderin: bazı yayın platformları harita işaretçisini yerleştirmek için bu alana ihtiyaç duyar. Gönderdiğiniz değerin ülkenin biçimine uygunluğu denetlenir (SY10014). Konumda hideAddress: true bulunduğunda şehir ve eyalet denetimleri atlanır.

Kullanım örneği: adres açılır listelerini doldurma. Bu verileri uygulama başlatılırken bir kez alın ve önbelleğe kaydedin. Ülke seçiciyi name/iso değerlerinden oluşturun ve bir ülke seçildiğinde eyalet seçiciyi o ülkenin states dizisinden doldurun. iso değerleri, create-location ve update-location uç noktalarındaki countryIso ve stateIso alanlarına doğrudan aktarılır.

Kullanım örneği: göndermeden önce adresi doğrulama. create-location çağrısını yapmadan önce hedef countryIso değerinin bu listede bulunduğunu, stateRequired değeri true olduğunda stateIso değerinin ilgili ülkenin altında yer aldığını ve hasCity değeri true olduğunda city alanının ayarlanmış olduğunu denetleyin. Desteklenmeyen bir kodun bu aşamada yakalanması, oluşturma çağrısından 400 alınması yerine istemci tarafında açık bir mesaj verilmesini sağlar. Tam yanıt büyüktür (desteklenen tüm ülkeleri içerir); yukarıdaki örnek tek bir kayıtla sınırlandırılmıştır. Sorgu parametresi yoktur; uç nokta her zaman tüm kümeyi döndürür.

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