Login Cadastre-se

Buscar cidades

Endpoint: POST https://croncrm.com/api/v2/states-and-cities/get-cities

Consulte cidades de endereços para os perfis de conversas.

Header do request
Atributo Descrição Obrigatório Tipo

apiKey

Informe sua API Key gerada na interface do CRONCRM.

Sim

String

Body do request

IMPORTANTE: Deixe vazio os campos abaixo para retornar todas as cidades disponíveis.

Atributo Descrição Obrigatório Tipo

state_id

Informe o ID do estado para retornar todas as cidades relacionadas.

Não

Inteiro

city_id

Informe o ID da cidade para retornar os dados da cidade escolhida.

Não

Inteiro

name

Informe o nome da cidade (ou parte) para buscar por proximidade.

Não

String 

{
  "state_id": 19
}
Response do request

Em caso de sucesso, retorna HTTP 200 com success true. Método incorreto retorna 405; falhas inesperadas retornam 500.

Atributo Descrição Tipo

success

Informa se a operação teve sucesso ou não.

Boolean

msg

Mensagem de retorno.

String

count

Total de registros encontrados.

Inteiro

cities

Lista de cidades encontradas.

id: (Inteiro) ID da cidade.

name: (String) Nome da cidade.

longitude: (String) Longitude da cidade.

latitude: (String) Latitude da cidade.

cod_ibge: (String) Código IBGE da cidade.

state: (Array) Estado relacionado.

Array 

{
  "success": true,
  "msg": "Consulta realizada com sucesso.",
  "count": 1,
  "cities": [
    {
      "id": 3658,
      "name": "Rio de Janeiro",
      "longitude": "-43.2003",
      "latitude": "-22.9129",
      "cod_ibge": "3304557",
      "state": {
        "id": 19,
        "name": "Rio de Janeiro",
        "uf": "RJ"
      }
    }
  ]
}
 
<?php
$apiKey = 'SEU_API_KEY';
$url = 'https://croncrm.com/api/v1/states-and-cities/get-cities';

$payload = [
    'state_id' => 19,
    // 'city_id' => 3658,
    // 'name' => 'Rio de Janeiro',
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'apiKey: ' . $apiKey,
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode($payload, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE),
]);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
$error = curl_error($ch);
curl_close($ch);

if ($error) {
    throw new RuntimeException($error);
}

echo "HTTP {$httpCode}\n";
echo $response;
?>
curl -X POST \
  'https://croncrm.com/api/v1/states-and-cities/get-cities' \
  -H 'apiKey: SEU_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"state_id":19}'