Geral ·
CidadesCadastroCadastro das Cidades do Omie
1consulta
0alterações
Claude · MCPpelos assistentes de IA
JSON · XMLformato
Obtém a lista das Cidades
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 12Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
apenas_importado_api | texto · até 1 | |
filtrar_apenas_alteracao | texto · até 1 | |
filtrar_apenas_inclusao | texto · até 1 | |
filtrar_cidade_contendo | texto · até 40 | |
filtrar_por_cidade | texto · até 40 | Código da Cidade Código da Cidade ou Código IBGE. |
filtrar_por_data_ate | texto · até 10 | |
filtrar_por_data_de | texto · até 10 | |
filtrar_por_uf | texto · até 2 | |
ordem_descrescente | texto · até 1 | |
ordenar_por | texto · até 100 | |
pagina | número inteiro | |
registros_por_pagina | número inteiro |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
lista_cidades | lista de objetos | |
lista_cidades[].cCod | texto | Código da Cidade |
lista_cidades[].cNome | texto | Nome da Cidade |
lista_cidades[].cUF | texto | UF da cidade |
lista_cidades[].nCodIBGE | texto | Código IBGE da Cidade |
lista_cidades[].nCodSIAFI | número inteiro | Código SIAFI da Cidade |
pagina | número inteiro | |
registros | número inteiro | |
total_de_paginas | número inteiro | |
total_de_registros | número inteiro |
POST /api/v1/geral/cidades/
curl -s https://app.omie.com.br/api/v1/geral/cidades/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "PesquisarCidades", "param": [{"pagina": 1, "registros_por_pagina": 50}]}'import os
import requests
corpo = {'call': 'PesquisarCidades', 'param': [{'pagina': 1, 'registros_por_pagina': 50}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/geral/cidades/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/geral/cidades/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "PesquisarCidades",
"param": [
{
"pagina": 1,
"registros_por_pagina": 50
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/cidades/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "PesquisarCidades",
"param": [
{
"pagina": 1,
"registros_por_pagina": 50
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/geral/cidades/")
corpo = <<~'JSON'
{
"call": "PesquisarCidades",
"param": [
{
"pagina": 1,
"registros_por_pagina": 50
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "PesquisarCidades",
"param": [
{
"pagina": 1,
"registros_por_pagina": 50
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/geral/cidades/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/geral/cidades/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""PesquisarCidades"", ""param"": [{""pagina"": 1, ""registros_por_pagina"": 50}]}")
]
),
Dados = Json.Document(Resposta)
in
Dados