Login Cadastre-se

Buscar estados

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

Consulte estados 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 todos os estados disponíveis.

Atributo Descrição Obrigatório Tipo

state_id

Informe o ID do estado desejado.

Não

Inteiro

name

Informe o nome do estado (ou parte) para buscar por proximidade.

Não

String 

{
  "name": "Rio"
}
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

states

Lista de estados encontrados.

id: (Inteiro) ID do estado.

name: (String) Nome do estado.

uf: (String) UF do estado.

Array 

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

$payload = [
    // 'name' => 'Rio',
    // 'state_id' => 19,
];

$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/v2/states-and-cities/get-states' \
  -H 'apiKey: SEU_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"name":"Rio"}'