Listar setores
Lista os códigos aceitos no campo sector; exige chave e não consome franquia.
get
/v1/enums/sectorsAutenticação: Authorization: Bearer <sua chave>. Como obter a chave
Devolve os códigos aceitos no campo sector da consulta unitária e do lote. O significado de cada setor e o efeito dele no resultado estão em Dados da consulta.
Exige chave de API, como toda rota em /v1/, e não consome franquia. Por isso é a forma recomendada de validar uma chave nova e de checar a saúde da integração.
Exemplos
Terminal
curl -sS "$GETTAX_URL/v1/enums/sectors" \ -H "Authorization: Bearer $GETTAX_KEY"gettax.mjs
// Node 18+ (fetch nativo). Rode com: node gettax.mjsconst response = await fetch(`${process.env.GETTAX_URL}/v1/enums/sectors`, { headers: { Authorization: `Bearer ${process.env.GETTAX_KEY}`, },}); const data = await response.json();if (!response.ok) throw new Error(`GetTax ${response.status}: ${data.error}`);console.log(data);gettax.py
import os import requests # pip install requests response = requests.get( f"{os.environ['GETTAX_URL']}/v1/enums/sectors", headers={"Authorization": f"Bearer {os.environ['GETTAX_KEY']}"}, timeout=30,)response.raise_for_status()print(response.json())Program.cs
// .NET 7+ (top-level statements). Rode com: dotnet runusing System.Net.Http.Headers; var baseUrl = Environment.GetEnvironmentVariable("GETTAX_URL");var apiKey = Environment.GetEnvironmentVariable("GETTAX_KEY"); using var http = new HttpClient();http.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", apiKey); using var response = await http.GetAsync($"{baseUrl}/v1/enums/sectors"); Console.WriteLine((int)response.StatusCode);Console.WriteLine(await response.Content.ReadAsStringAsync());GetTax.java
// Java 17+. Rode com: java GetTax.javaimport java.net.URI;import java.net.http.HttpClient;import java.net.http.HttpRequest;import java.net.http.HttpResponse; public class GetTax { public static void main(String[] args) throws Exception { var baseUrl = System.getenv("GETTAX_URL"); var apiKey = System.getenv("GETTAX_KEY"); var request = HttpRequest.newBuilder(URI.create(baseUrl + "/v1/enums/sectors")) .header("Authorization", "Bearer " + apiKey) .GET() .build(); var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.statusCode()); System.out.println(response.body()); }}gettax.php
<?php// PHP 8+ com a extensão curl. Rode com: php gettax.php$ch = curl_init(getenv('GETTAX_URL') . '/v1/enums/sectors');curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ' . getenv('GETTAX_KEY'), ],]); $body = curl_exec($ch);if ($body === false) { throw new RuntimeException(curl_error($ch));} echo curl_getinfo($ch, CURLINFO_RESPONSE_CODE), PHP_EOL, $body, PHP_EOL;GetTax.dpr
// Delphi XE8+ (System.Net.HttpClient, sem componentes de terceiros).program GetTax; {$APPTYPE CONSOLE} uses System.SysUtils, System.Classes, System.Net.HttpClient, System.Net.URLClient; var Client: THTTPClient; Response: IHTTPResponse;begin Client := THTTPClient.Create; try Response := Client.Get(GetEnvironmentVariable('GETTAX_URL') + '/v1/enums/sectors', nil, [ TNetHeader.Create('Authorization', 'Bearer ' + GetEnvironmentVariable('GETTAX_KEY')) ]); Writeln(Response.StatusCode); Writeln(Response.ContentAsString(TEncoding.UTF8)); finally Client.Free; end;end.Respostas
200Lista de setores.›
sectorsarray<string>obrigatórioCódigos de setor aceitos hoje. A lista pode crescer: leia daqui em vez de fixá-la no código.
Exemplo · 200
{ "sectors": [ "VAREJO_GERAL", "BAR_RESTAURANTE", "PRODUTOR_RURAL", "GOVERNO", "ATACADO", "ZONA_FRANCA" ]}401Chave ausente, malformada, inexistente, revogada ou de cliente desativado.›
errorstringobrigatórioCódigo do erro, sem mensagem detalhada. Ver Erros e novas tentativas.Valores:INVALID_API_KEY
Exemplo · 401
{ "error": "INVALID_API_KEY"}500Erro inesperado. Repita com backoff exponencial.›
errorstringobrigatórioCódigo do erro, sem mensagem detalhada. Ver Erros e novas tentativas.Valores:INTERNAL_ERROR
Exemplo · 500
{ "error": "INTERNAL_ERROR"}503Serviço temporariamente indisponível. Repita com backoff exponencial.›
errorstringobrigatórioCódigo do erro, sem mensagem detalhada. Ver Erros e novas tentativas.Valores:SERVICE_UNAVAILABLE
Exemplo · 503
{ "error": "SERVICE_UNAVAILABLE"}