Cidades

Visão Geral

O módulo Cidades fornece uma lista de cidades disponíveis no sistema, incluindo o código IBGE e a UF. É utilizado como referência para preenchimento de endereços em cadastros de pessoas, empresas e contadores.

Base URL

/api/cidades
Todos os endpoints requerem autenticação via Bearer Token:
Authorization: Bearer {token}
Este módulo é somente leitura. Não é possível criar, editar ou remover cidades via API.

Endpoints

GET /api/cidades

Descrição: Retorna a lista completa de cidades cadastradas no sistema com seus respectivos códigos IBGE e UF.

Parâmetros

Nenhum parâmetro de query.

Resposta de Sucesso 200

[
  {
    "id": 1,
    "codigoIbge": 3550308,
    "descricao": "São Paulo",
    "uf": "SP"
  },
  {
    "id": 2,
    "codigoIbge": 3304557,
    "descricao": "Rio de Janeiro",
    "uf": "RJ"
  }
]

Campos da Resposta

CampoTipoDescrição
idinteger (int64)Identificador único da cidade no sistema
codigoIbgeintegerCódigo IBGE do município
descricaostringNome da cidade
ufstringSigla do estado (UF)

Códigos de Erro

CódigoDescrição
401Token ausente ou inválido
500Erro interno do servidor

Exemplos de Código

cURL

curl -X GET "https://api.app.hooked.com.br/api/cidades" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/cidades', {
  headers: { 'Authorization': 'Bearer {token}' }
});
const data = await response.json();

Python

import requests

data = requests.get(
    'https://api.app.hooked.com.br/api/cidades',
    headers={'Authorization': 'Bearer {token}'}
).json()

Go

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("GET", "https://api.app.hooked.com.br/api/cidades", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/cidades');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — GET /api/cidades",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/cidades",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}
← PessoasPaíses →