Listings APIListings API
Anmelden
GET/api/v4/countries

Unterstützte Länder und Bundesstaaten auflisten

Liefert von Listings API unterstützte Länder, Bundesstaaten/Provinzen, ISO-Codes für Standorte und je Land erforderliche oder geprüfte Adressfelder.

Erfordert einen API-Schlüssel. Format des Headers und Schlüsselrotation finden Sie unter Authentifizierung.

Parameter

Dieser Endpunkt hat keine Parameter.

Antworten

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.

Gibt den vollständigen Katalog der Länder und ihrer Untergliederungen (Bundesstaaten, Provinzen, Territorien) zurück, die Listings API für Standortdaten unterstützt. Jeder Ländereintrag enthält seinen ISO-Code (iso), eine Relay-id, eine numerische databaseId, ein states-Array und drei Flags, die angeben, wie die Adresse eines Standorts in diesem Land geprüft wird. Jeder Bundesstaat enthält seine eigene iso und eine numerische id. Für Länder, die Listings API nicht untergliedert, wird ein leeres states-Array zurückgegeben.

Adressregeln pro Land

Flagtruefalse
hasCitycity ist beim Erstellen erforderlich (SY10126).Das Land verwendet keine Adressierung auf Stadtebene. Ein von Ihnen gesendeter Wert für city wird verworfen.
stateRequiredstateIso ist erforderlich und muss einem der Werte in states des Landes entsprechen (SY10010).Lassen Sie stateIso weg. Für einige dieser Länder werden dennoch states aufgeführt; ein von Ihnen gesendeter Wert wird ohne Prüfung gespeichert.
hasPostalCodeDas Land verwendet Postleitzahlen. Senden Sie postalCode zusammen mit der Adresse.Das Land hat kein Postleitzahlensystem. Lassen Sie postalCode weg.

postalCode ist in jedem Land optional, sollte aber immer gesendet werden, wenn hasPostalCode den Wert true hat: Einige Plattformen benötigen diesen Wert, um die Kartenmarkierung zu platzieren. Ein von Ihnen gesendeter Wert wird anhand des landesspezifischen Formats geprüft (SY10014). Wenn beim Standort hideAddress: true gesetzt ist, werden die Prüfungen für Stadt und Bundesstaat übersprungen.

Anwendungsfall: Adress-Dropdowns befüllen. Rufen Sie diese Daten einmal beim Start der App ab und speichern Sie sie im Cache. Erstellen Sie die Länderauswahl aus name/iso und befüllen Sie nach der Auswahl eines Landes die Bundesstaatenauswahl aus dessen states. Die iso-Werte werden direkt in die Felder countryIso und stateIso der Endpunkte create-location und update-location übernommen.

Anwendungsfall: Eine Adresse vor dem Übermitteln validieren. Prüfen Sie vor dem Aufruf von create-location, ob der vorgesehene Wert für countryIso in dieser Liste vorhanden ist, ob stateIso unter diesem Land aufgeführt ist, wenn stateRequired den Wert true hat, und ob city gesetzt ist, wenn hasCity den Wert true hat. Wenn Sie einen nicht unterstützten Code bereits hier erkennen, erhalten Sie eine klare clientseitige Meldung statt eines 400 beim Aufruf zum Erstellen. Die vollständige Antwort ist umfangreich (alle unterstützten Länder); das obige Beispiel ist auf einen Eintrag gekürzt. Es gibt keine Abfrageparameter; der Endpunkt gibt immer den vollständigen Datensatz zurück.

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