Integrações com o sistema tributário

Acesso à API Cadastro do Geo360

A documentação da API de Cadastro Territorial do Geo360 pode ser encontrada no link abaixo:

Ambiente	URL	Swagger
Ambiente de desenvolvimento	`cadastro.desenvolvimento.geo360.topocart.dev.br`	NinjaAPI (opens in a new tab)
Ambiente de produção	`cadastro.geo360.topocart.dev.br`	NinjaAPI (opens in a new tab)

O acesso à API Cadastro é realizado passando o header Authorization: Bearer <authToken>, onde o authToken é retornado pelo endpoint POST /login da API Plataforma, como no cURL abaixo:

curl --location 'https://plataforma.desenvolvimento.geo360.topocart.dev.br/login' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": <seu email>,
    "senha": <sua senha>
}'

NOTA: O token é válido apenas para o ambiente de desenvolvimento. Para o ambiente de produção consulte à TI da Topocart sobre credenciais válidas de acesso na URL plataforma.geo360.com.br

Um exemplo de requisição à API Cadastro com o token valido é o seguinte:

curl --location 'https://cadastro.desenvolvimento.geo360.topocart.dev.br/sabara/imobiliario/10855' \
--header 'Authorization: Bearer <authToken>'

Endpoints

Método	Endpoint	Descrição
POST	`/crud/<municipio>/imobiliario/`	Criar novo imóvel
PUT	`/crud/<municipio>/imobiliario/`	Atualizar imóvel
GET	`/<municipio>/imobiliario/:id/`	Consulta imóveis pelo id
GET	`/crud/<municipio>/imobiliario/campos/`	Lista os campos da tabela imobiliario
POST	`/crud/<municipio>/lote/`	Criar novo lote
PUT	`/crud/<municipio>/lote/`	Atualizar lote
GET	`/<municipio>/lote/:id/`	Consulta lotes pelo id
GET	`/crud/<municipio>/lote/campos/`	Lista os campos da tabela lote
POST	`/crud/<municipio>/logradouro/`	Criar novo logradouros
PUT	`/crud/<municipio>/logradouro/`	Atualizar logradouros
GET	`/<municipio>/logradouro/:id/`	Consulta logradouros pelo id
GET	`/crud/<municipio>/logradouro/campos/`	Lista os campos da tabela logradouro
POST	`/crud/<municipio>/pessoa/`	Criar novo pessoas
PUT	`/crud/<municipio>/pessoa/`	Atualizar pessoas
GET	`/<municipio>/pessoa/:id/`	Consulta pessoas pelo id
GET	`/crud/<municipio>/pessoa/campos/`	Lista os campos da tabela pessoa
POST	`/crud/<municipio>/bairro/`	Criar novo bairros
PUT	`/crud/<municipio>/bairro/`	Atualizar bairros
GET	`/<municipio>/bairro/:id/`	Consulta bairros pelo id
GET	`/crud/<municipio>/bairro/campos/`	Lista os campos da tabela bairro
POST	`/crud/<municipio>/edificacao/`	Criar novo edificacoes
PUT	`/crud/<municipio>/edificacao/`	Atualizar edificacoes
GET	`/<municipio>/edificacao/:id/`	Consulta edificacoes pelo id
GET	`/crud/<municipio>/edificacao/campos/`	Lista os campos da tabela edificacao
POST	`/crud/<municipio>/quadra/`	Criar novo quadras
PUT	`/crud/<municipio>/quadra/`	Atualizar quadras
GET	`/<municipio>/quadra/:id/`	Consulta quadras pelo id
GET	`/crud/<municipio>/quadra/campos/`	Lista os campos da tabela quadra
POST	`/crud/<municipio>/face_quadra/`	Criar novo face_quadras
PUT	`/crud/<municipio>/face_quadra/`	Atualizar face_quadras
GET	`/<municipio>/face_quadra/:id/`	Consulta face_quadras pelo id
GET	`/crud/<municipio>/face_quadra/campos/`	Lista os campos da tabela face_quadras
GET	`/dominios/<municipio>/<campo>`	Retorna os domínios do campo informado
POST	`/dominios/<municipio>/<campo>`	Cria um novo domínio
PUT	`/dominios/<municipio>/<campo>/<dominio_id>`	Atualiza um domínio existente
DELETE	`/dominios/<municipio>/<campo>/<dominio_id>`	Deleta um domínio existente
GET	`/sabara/logradouro_por_bairro_codigo_secao/<codigo do bairro>/<codigo do logradouro>/<codigo da secao>`	Retorna um lograoduro para um dado bairro, logradouro e secao *

NOTA: <municipio> = sabara

NOTA: O endpoint logradouro_por_bairro_codigo_secao existe apenas para o tenant de Sabará

Exemplos de JSON para envio/resposta

Imobiliário

{
    "id": 57002,
    "geom": "0101000020E61000002E68467887F345C09A6CDD0F27E133C0",
    "inscricao_cartografica": "011001230181002",
    "complemento": null,
    "nr_porta": null,
    "utilizacao": null,
    "lote": {
        "id": 62705,
        "geom": "0103000020E61000000100000008000000E35F273E84F345C0105B790331E133C0767B53B98BF345C0FE35FC6025E133C01E84568E8BF345C039752A0525E133C0B4D42DAC89F345C02DAEC60320E133C0CAD1AA0383F345C035A3BEBE28E133C074A67EA581F345C048BEE4892AE133C064394F6F82F345C04A0832812CE133C0E35F273E84F345C0105B790331E133C0",
        "ocupacao": null
    },
    "imobiliario_area": null,
    "edificacao": [],
    "pessoa": [
        {
            "id": 3155
        }
    ],
    "logradouro": null,
    "id_imobiliario_pessoa": [
        47045
    ]
}

Lote

{
    "id": 10230,
    "geom": "0103000020E6100000010000000B000000DB85BE7C7BEC45C04FFA2708DBE133C00B792D8A7AEC45C0EFC8EA33DCE133C0555D79A076EC45C03B35F860E1E133C0504FF8347AEC45C0EA48AEF2E4E133C0D6AD165E7DEC45C0BE06FD0DE8E133C06C349E717FEC45C0E17AFA9EE3E133C0B58507FE86EC45C0CA5815BBD8E133C0C11E3BD183EC45C011ABB639D0E133C0FFE92C9F7FEC45C008BD0300D6E133C06E6D619D7EEC45C09C14D993D7E133C0DB85BE7C7BEC45C04FFA2708DBE133C0",
    "inscricao_cartografica": "010801030548",
    "nr_lote": "0548",
    "id_bairro": 53,
    "id_quadra": 152,
    "id_face_quadra": null,
    "validacao_cadastro": 2,
    "tipo_imposto": null,
    "id_distrito": null,
    "id_setor": 48,
    "complemento_lote": null,
    "quadra": null,
    "area_construida_privativa": 376.74,
    "area_privativa": 825.0,
    "id_foto_fachada_prioridade": 79,
    "situacao_foto": 6,
    "id_testada": null,
    "ocupacao": 6,
    "patrimonio": 1,
    "situacao_lote": 4,
    "topografia": 1,
    "pedologia": null,
    "calcada": false,
    "limitacao": 2,
    "meio_fio": false,
    "condominio": false,
    "revisita": null,
    "nr_lote_antigo": "0011",
    "unidades_excecao": null,
    "projetados": false,
    "id_area_cadastro": 36,
    "piscina": false,
    "ct_observacao": null,
    "area_geometrica": "863.64",
    "area_legado": "825.00",
    "area_equivalente": 825.0,
    "area_construida_comum": 0.0,
    "area_comum": 0.0,
    "calculo_fracao": 1,
    "id_condominio": null,
    "lote_comum": null,
    "area_manual": null,
    "qt_imobiliario": 1,
    "remanescentes": null
}

Logradouro

{
    "id": 50,
    "geom": "0102000020E6100000050000001C8E738F39E845C088B941FD34E533C0E09EF16D33E845C01DD5C06C32E533C05D15E0CB2FE845C0928D5A4131E533C0763118FB2BE845C0F431DBF630E533C014559E6820E845C0F1F246112EE533C0",
    "codigo": null,
    "nome": "PONTILHAO DE SABARÁ",
    "cep": null,
    "coleta_de_lixo": null,
    "agua": true,
    "esgoto": false,
    "energia_eletrica": true,
    "iluminacao_publica": true,
    "tipo_logradouro": 1,
    "sarjeta": true,
    "id_bairro": 56,
    "id_setor": null,
    "galeria_pluvial": false,
    "limpeza_urbana": false,
    "rede_de_telefonia": true,
    "frequencia_de_lixo": null,
    "transporte_publico": false,
    "pavimentacao": 1,
    "ficticio": false,
    "meio_fio": true,
    "observacao": null
}

Bairro

{
    "id": 14,
    "geom": "0103000020E61000000100000019000000931BC241CDE545C09472E0C5CADF33C02BE49704C2E545C0484A9285FADF33C0768E1A08BFE545C05753364D24E033C03BD16E2CC1E50",
    "codigo": "39",
    "nome": "Mangabeiras",
    "cd_setor": null,
    "cd_regional": null
}

Pessoa

{
    "id": 15530,
    "codigo": "50166",
    "nome": "JOSE ROBERTO SOARES SILVA E OUTRA",
    "cpf_cnpj": "-----------",
    "dt_criacao": "2022-04-21T10:31:37.029",
    "tipo": "PF",
    "data_alteracao": "2022-04-21T13:31:37.029Z",
    "cpf_cnpj_valido": true,
    "rg": "---------",
    "telefone": "(--) --------",
    "email": ""
}

Consultando entidades relacionadas ao imóvel

É possível realizar buscas a partir de outros atributos de uma camada através do endpoint:

GET /crud/<municipio>/<camada>/search/<tipo>/<campo>/

Onde:

<municipio> = sabara
<tipo> = tipo da busca, podendo ser: exact, startwith, istartwith, contains, icontains
<campo> = campo a ser utilizado na busca

Por exemplo, buscando pela inscrição do imóvel:

curl --location 'http://cadastro.desenvolvimento.geo360.topocart.dev.br/search/sabara/imobiliario?inscricao_cartografica=010600630065001' \
--header 'Authorization: Bearer <seu token>'

Consultando um logradouro por bairro, logradouro e secao

É possivel obter um logradouro por bairro, logradouro e secao através do endpoint:

GET /sabara/logradouro_por_bairro_codigo_secao/<codigo do bairro>/<codigo do logradouro>/<codigo da secao>

Por exemplo, obtendo um logradouro por bairro, logradouro e secao:

curl --location 'http://cadastro.desenvolvimento.geo360.topocart.dev.br/sabara/logradouro_por_bairro_codigo_secao/1/84/3' \
--header 'Authorization: Bearer <seu token>'