Consultar cities

GET /api/v1/cities

O que este endpoint faz

Este endpoint retorna os dados de cities para consulta, conferência ou composição de telas e integrações. Ele pertence ao domínio de recursos auxiliares usados pelo app e pelas integrações.

Use GET /api/v1/cities quando a integração precisar acionar esse comportamento exatamente como o app da Antecipa Fácil faz pelo gateway público.

Para que serve

Ele ajuda a compor fluxos de integração do backend do parceiro com a plataforma, mantendo autenticação via Bearer token e tráfego pelo APIM. Consulte os parâmetros, corpo de requisição e respostas desta página antes de usar em produção.

Gateway

Chame sempre https://api.antecipafacil.net.br/api/v1/cities. O APIM repassa a rota para o backend correto; serviços internos não devem ser chamados diretamente.

Parâmetros

Este endpoint não declara parâmetros adicionais na especificação OpenAPI.

Respostas

200 Operação executada com sucesso.

Try it GET

URL Bearer token Try it!

Clique em Try it! para executar a chamada pelo navegador.

Exemplos

ShellNodeDenoPythonC#Rust

curl --request GET \
  --url 'https://api.antecipafacil.net.br/api/v1/cities' \
  --header 'accept: application/json' \
  --header 'Authorization: Bearer <access_token>'

const response = await fetch('https://api.antecipafacil.net.br/api/v1/cities', {
  method: 'GET',
  headers: {
    accept: 'application/json',
    Authorization: 'Bearer <access_token>',
  },
});

const data = await response.json();
console.log(data);

const response = await fetch('https://api.antecipafacil.net.br/api/v1/cities', {
  method: 'GET',
  headers: {
    accept: 'application/json',
    Authorization: 'Bearer <access_token>',
  },
});

console.log(await response.json());

import requests

url = "https://api.antecipafacil.net.br/api/v1/cities"
headers = {
    "accept": "application/json",
    "Authorization": "Bearer <access_token>",
}

response = requests.get(url, headers=headers)
response.raise_for_status()
print(response.json())

using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.antecipafacil.net.br/api/v1/cities");
request.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<access_token>");

using var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

let client = reqwest::Client::new();
let response = client
    .request(reqwest::Method::GET, "https://api.antecipafacil.net.br/api/v1/cities")
    .bearer_auth("<access_token>")
    .header("accept", "application/json")
    .send()
    .await?;

let body = response.text().await?;
println!("{}", body);

Copiar exemplo