Países / Estados / Cidades

Como obter a lista de países cadastrados no Zeev utilizando API?

Autenticação: Primeiro obtenha um token de autenticação com permissão de realizar essa operação;
Enviar requisição: Enviar a requisição para o endpoint Países / Estados / Cidades;
oData: opcionalmente, utilize regras oData para manipular o resultado da API. Essa API aceita $filter, e $orderby.

Lista todos os países cadastrados, com a opção de filtrar por palavra chave com similaridade pelo nome

get

Parâmetros de consulta

namestringOpcional

Nome do país

Respostas

200

Sucesso.

400

Solicitação ou dados da solicitação são inválidas

401

Pessoa não autorizada

403

Pessoa não tem permissão de executar essa operação

404

O registro não foi encontrado

429

Muitas requisições em um determinado período de tempo

500

Ocorreu algum erro interno no servidor

get

/api/2/geo/countries

GET /api/2/geo/countries HTTP/1.1
Host: seu_endereco.do.zeev
Accept: */*

[
  {
    "id": 1,
    "name": "text"
  }
]

Exemplo de requisição para obter a lista de países cadastrados no Zeev

const myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Bearer TOKEN_DO_USUARIO");

const requestOptions = {
  method: "GET",
  headers: myHeaders
};

try {
  const response = await fetch("https://seu_endereco.do.zeev/api/2/geo/countries?name=consequat", requestOptions);
  const result = await response.json();
  console.log(result)
} catch (error) {
  console.error(error);
};

Como obter a lista de estados pelo código do País utilizando API?

Autenticação: Primeiro obtenha um token de autenticação com permissão de realizar essa operação;
Obter o countryid: Obtenha o código identificador do país em Avançado > Países, ou através de uma requisição de API para o endpoint Países / Estados / Cidades;
Enviar requisição: Enviar a requisição para o endpoint Países / Estados / Cidades;
oData: opcionalmente, utilize regras oData para manipular o resultado da API. Essa API aceita $filter, $orderby.

Na requisição lembre-se de trocar seu_endereco.do.zeev pelo endereço que você utiliza para acessar o Zeev.

Lista todos os estados de um país com a opção de filtrar por palavra chave com similaridade pelo nome do estado

get

Parâmetros de rota

countryIdinteger · int32Obrigatório

Código do país

Parâmetros de consulta

namestringOpcional

Nome do estado

Respostas

200

Sucesso.

400

Solicitação ou dados da solicitação são inválidas

401

Pessoa não autorizada

403

Pessoa não tem permissão de executar essa operação

404

O registro não foi encontrado

429

Muitas requisições em um determinado período de tempo

500

Ocorreu algum erro interno no servidor

get

/api/2/geo/countries/{countryid}/states

GET /api/2/geo/countries/{countryid}/states HTTP/1.1
Host: seu_endereco.do.zeev
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "sign": "text",
    "countryId": 1,
    "country": "text"
  }
]

Exemplo de requisição para obter os estados vinculados a um país

let counrtyId = 2;

const myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Bearer TOKEN_DO_USUARIO");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

try {
  const response = await fetch(`https://seu_endereco.do.zeev/api/2/geo/countries/${countryId}/states`, requestOptions);
  const result = await response.text();
  console.log(result)
} catch (error) {
  console.error(error);
};

Como listar as cidades de um estado?

Autenticação: Primeiro obtenha um token de autenticação com permissão de realizar essa operação;
Obter o stateid: Obtenha o código identificador da cidade em Avançado > Cidades, ou através de uma requisição de API para o endpoint Países / Estados / Cidades;
Enviar requisição: Enviar a requisição para o endpoint Países / Estados / Cidades;
oData: opcionalmente, utilize regras oData para manipular o resultado da API. Essa API aceita $filter, $orderby .

Na requisição lembre-se de trocar seu_endereco.do.zeev pelo endereço que você utiliza para acessar o Zeev.

Lista todas as cidades de um estado com a opção de filtrar por palavra chave com similaridade pelo nome da cidade

get

Parâmetros de rota

stateIdinteger · int32Obrigatório

Código do estado

Parâmetros de consulta

namestringOpcional

Nome da cidade

Respostas

200

Sucesso.

400

Solicitação ou dados da solicitação são inválidas

401

Pessoa não autorizada

403

Pessoa não tem permissão de executar essa operação

404

O registro não foi encontrado

429

Muitas requisições em um determinado período de tempo

500

Ocorreu algum erro interno no servidor

get

/api/2/geo/states/{stateid}/cities

GET /api/2/geo/states/{stateid}/cities HTTP/1.1
Host: seu_endereco.do.zeev
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "stateId": 1,
    "state": "text",
    "countryId": 1,
    "country": "text"
  }
]

Exemplo de requisição para obter as cidades de um estado

let stateId = 1;
const myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Bearer TOKEN_DO_USUARIO");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

try {
  const response = await fetch(`https://seu_endereco.do.zeev/api/2/geo/states/${stateId}/cities`, requestOptions);
  const result = await response.json();
  console.log(result)
} catch (error) {
  console.error(error);
};

Links relacionados:

AnteriorOutros PróximoServiços

Atualizado há 1 ano