GET/api/v4/countries

Listar países e estados compatíveis

Retorna países aceitos pela Listings API, estados/províncias, códigos ISO para criar/atualizar locais e campos de endereço exigidos ou verificados.

Requer uma chave de API. Consulte Autenticação para ver o formato do cabeçalho e a rotação de chaves.

Parâmetros

Este endpoint não recebe parâmetros.

Respostas

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.

Retorna o catálogo completo de países e suas subdivisões (estados, províncias, territórios) aceitos pela Listings API para dados de locais. Cada registro de país contém seu código ISO (iso), um id do Relay, um databaseId numérico, um array states e três indicadores que informam como o endereço de um local é verificado nesse país. Cada estado contém seu próprio iso e um id numérico. Os países que a Listings API não subdivide retornam um array states vazio.

Regras de endereço por país

Indicadortruefalse
hasCitycity é obrigatório na criação (SY10126).O país não utiliza endereçamento por cidade. Se você enviar city, esse valor será descartado.
stateRequiredstateIso é obrigatório e deve ser um dos valores de states do país (SY10010).Omita stateIso. Alguns desses países ainda apresentam states; se você enviar um valor, ele será armazenado sem verificação.
hasPostalCodeO país utiliza códigos postais. Envie postalCode com o endereço.O país não possui um sistema de códigos postais. Omita postalCode.

postalCode é opcional em todos os países, mas envie esse campo sempre que hasPostalCode for true: algumas plataformas de publicação precisam dele para posicionar o marcador no mapa. Se você enviar um valor, ele será verificado de acordo com o formato do país (SY10014). Com hideAddress: true no local, as verificações de cidade e estado são ignoradas.

Caso de uso: preencher listas suspensas de endereço. Faça essa consulta uma vez ao iniciar o aplicativo e armazene o resultado em cache. Renderize o seletor de país a partir de name/iso e, quando um país for escolhido, preencha o seletor de estado a partir de states desse país. Os valores de iso são usados diretamente nos campos countryIso e stateIso dos endpoints create-location e update-location.

Caso de uso: validar um endereço antes de enviá-lo. Antes de chamar create-location, verifique se o countryIso desejado existe nesta lista, se stateIso aparece entre os valores desse país quando stateRequired é true e se city está definido quando hasCity é true. Detectar um código não aceito nesta etapa permite exibir uma mensagem clara no lado do cliente em vez de receber um 400 da chamada de criação. A resposta completa é extensa (todos os países aceitos); o exemplo acima foi reduzido a um único registro. Não há parâmetros de consulta; o endpoint sempre retorna o conjunto completo.

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