Autentique GenderAPI v2 com sua chave API existente. Aprenda cabeçalhos Bearer, chaves de consulta GET, acesso de teste IP e solicitações JSON.
Autenticação e teste gratuito
Envie Authorization: Bearer YOUR_API_KEY do seu servidor. Substitua YOUR_API_KEY pela sua chave GenderAPI existente. Ambas as versões compartilham seu saldo; nenhuma assinatura ou chave v2 separada é necessária.
Todas as solicitações POST requerem Content-Type: application/json. Use sua chave Bearer API existente. Cada solicitação é processada de forma independente; solicitações repetidas usam faturamento normal.
Somente GET /gender também aceita o parâmetro de consulta chave. Prefira o cabeçalho Authorization para integrações porque os URLs podem ser armazenados no histórico e nos logs do navegador. Não coloque chaves privadas no código frontend.
Se uma chave de API estiver faltando, tiver um formato inválido ou não for reconhecida, a solicitação usa o IP de teste compartilhado com v1. Isto não se aplica a chaves reconhecidas que estão desativadas, expiradas ou restritas. Verifique o modo de acesso em meta.access.mode: api_key, ip_trial ou unauthenticated. O motivo do teste é api_key_missing, api_key_invalid ou api_key_not_found. Uma chave inválida ainda pode receber uma resposta de teste bem-sucedida. Verifique o modo de acesso na produção.
Os créditos de teste são redefinidos após um período de 24 horas, não necessariamente à meia-noite. Use /usage para ler resets_at. Pessoas por trás do mesmo IP público compartilham esse subsídio.
Copie sua chave API de sua conta GenderAPI. Substitua YOUR_API_KEY abaixo por essa chave e execute o exemplo escolhido na mesma sessão de terminal. Esses comandos definem uma variável de ambiente somente para essa sessão; o espaço reservado publicado não é uma chave funcional.
Para um aplicativo ou implantação, configure GENDERAPI_API_KEY como um segredo do lado do servidor. Os exemplos não carregam automaticamente um arquivo .env. Mantenha a chave longe de pacotes de navegador, controle de origem e URLs públicos.
terminal macOS/Linux
export GENDERAPI_API_KEY='YOUR_API_KEY'
Windows PowerShell
$env:GENDERAPI_API_KEY = 'YOUR_API_KEY'
Verifique o acesso sem gastar créditos
Chame GET /usage com o cabeçalho Bearer. Uma chave de conta válida produz meta.access.mode: api_key. Se o resultado indicar ip_trial, verifique a chave copiada antes de executar previsões. Esta solicitação é gratuita, inclusive para uma conta sem créditos restantes.
Escolha uma linguagem de programação.Configure sua chave API, e execute o exemplo em seu servidor.
Esta leitura de saldo não custa créditos. Ainda conta para os limites de taxa de solicitação.
Antes de executar: acesso e tratamento de erros
Execute estes exemplos em seu servidor. Configure GENDERAPI_API_KEY no ambiente de processo para sua chave API existente. Confirme que meta.access.mode é api_key: uma chave não reconhecida pode retornar à avaliação IP.
As respostas HTTP 4xx e 5xx JSON preservam o corpo do erro e retornam um status de saída diferente de zero. Verifique code, action e meta.usage.billing_status antes de tentar novamente.
import jsonimport osimport sysimport urllib.errorimport urllib.requestapi_key = os.environ.get("GENDERAPI_API_KEY")if not api_key: raise RuntimeError("Set GENDERAPI_API_KEY")class NoRedirect(urllib.request.HTTPRedirectHandler): def redirect_request(self, req, fp, code, msg, headers, newurl): return Nonerequest = urllib.request.Request( "https://api.genderapi.io/api/v2/usage", method="GET", headers={ "Authorization": "Bearer " + api_key, },)opener = urllib.request.build_opener(NoRedirect())try: response = opener.open(request, timeout=30)except urllib.error.HTTPError as error: response = error # Keep the Problem Details body on non-2xx responses.with response: status = response.status raw = response.read().decode("utf-8") if "json" not in response.headers.get("Content-Type", ""): raise RuntimeError(f"HTTP {status}: expected a JSON response") result = json.loads(raw)print(json.dumps(result, indent=2), file=sys.stderr if status >= 300 else sys.stdout)if not 200 <= status < 300: sys.exit(1) # Inspect code, action and billing before retrying.# For batches, inspect every item even when HTTP status is 200.
import java.net.URI;import java.net.http.HttpClient;import java.net.http.HttpRequest;import java.net.http.HttpResponse;import java.nio.charset.StandardCharsets;import java.time.Duration;public class GenderApiExample { private static String requiredEnv(String name) { String value = System.getenv(name); if (value == null || value.isBlank()) throw new IllegalStateException("Set " + name); return value; } public static void main(String[] args) throws Exception { String apiKey = requiredEnv("GENDERAPI_API_KEY"); HttpClient client = HttpClient.newBuilder() .connectTimeout(Duration.ofSeconds(10)) .followRedirects(HttpClient.Redirect.NEVER) .build(); HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.genderapi.io/api/v2/usage")) .timeout(Duration.ofSeconds(30)) .header("Authorization", "Bearer " + apiKey) .GET() .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString(StandardCharsets.UTF_8)); if (!response.headers().firstValue("content-type").orElse("").contains("json")) { throw new IllegalStateException("HTTP " + response.statusCode() + ": expected JSON"); } // JSON text; parse with your application's JSON library when integrating. if (response.statusCode() < 200 || response.statusCode() >= 300) { System.err.println(response.body()); // Includes Problem Details. System.exit(1); } System.out.println(response.body()); // For batches, inspect each item's data or error, including on HTTP 200. }}
Java 17+; cliente HTTP padrão. Salve como GenderApiExample.java e execute java GenderApiExample.java. Documentação de tempo de execução
C# / .NET
using System;using System.Net.Http;using System.Net.Http.Headers;using System.Text;using System.Text.Json;string RequiredEnv(string name) => !string.IsNullOrWhiteSpace(Environment.GetEnvironmentVariable(name)) ? Environment.GetEnvironmentVariable(name)! : throw new InvalidOperationException($"Set {name}");var apiKey = RequiredEnv("GENDERAPI_API_KEY");using var handler = new HttpClientHandler { AllowAutoRedirect = false };using var client = new HttpClient(handler) { Timeout = TimeSpan.FromSeconds(30) };using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.genderapi.io/api/v2/usage");request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", apiKey);using var response = await client.SendAsync(request);var raw = await response.Content.ReadAsStringAsync();if (!(response.Content.Headers.ContentType?.MediaType?.Contains("json") ?? false)) throw new InvalidOperationException($"HTTP {(int)response.StatusCode}: expected JSON");using var result = JsonDocument.Parse(raw);if (!response.IsSuccessStatusCode){ Console.Error.WriteLine(result.RootElement); // Preserve Problem Details. Environment.ExitCode = 1;}else{ Console.WriteLine(result.RootElement); // For batches, inspect every item even on HTTP 200.}