Autentiser GenderAPI v2 med din eksisterende API-nøkkel. Lær Bearer-overskrifter, GET spørringsnøkler, IP prøvetilgang og JSON-forespørsler.
Autentisering og gratis prøveversjon
Send Authorization: Bearer YOUR_API_KEY fra serveren din. Erstatt YOUR_API_KEY med din eksisterende GenderAPI-nøkkel. Begge versjonene deler saldoen din; ingen separat v2-abonnement eller nøkkel er nødvendig.
Alle POST-forespørsler krever Content-Type: application/json. Bruk din eksisterende Bearer API-nøkkel. Hver forespørsel behandles uavhengig; gjentatte forespørsler bruker normal fakturering.
Bare GET /gender godtar også nøkkelspørringsparameteren. Foretrekk Autorisasjonsoverskriften for integrasjoner fordi URL-er kan lagres i nettleserloggen og logger. Ikke legg private nøkler i grensesnittkoden.
Hvis en API-nøkkel mangler, har et ugyldig format eller ikke gjenkjennes, bruker forespørselen IP-prøveversjonen som er delt med v1. Dette gjelder ikke gjenkjente nøkler som er deaktivert, utløpt eller begrenset. Sjekk tilgangsmodusen i meta.access.mode: api_key, ip_trial eller unauthenticated. Årsaken til prøveversjonen er api_key_missing, api_key_invalid eller api_key_not_found. En ugyldig nøkkel kan derfor fortsatt motta et vellykket prøvesvar. Bekreft tilgangsmodusen i produksjonen.
Prøvekreditter tilbakestilles etter en 24-timers periode, ikke nødvendigvis ved midnatt. Bruk /usage for å lese resets_at. Folk bak den samme offentlige IP deler denne godtgjørelsen.
Kopier API-nøkkelen fra GenderAPI-kontoen din. Erstatt YOUR_API_KEY nedenfor med den nøkkelen, og kjør deretter ditt valgte eksempel i samme terminaløkt. Disse kommandoene angir kun en miljøvariabel for den økten; den publiserte plassholderen er ikke en arbeidsnøkkel.
For en applikasjon eller distribusjon, konfigurer GENDERAPI_API_KEY som en serversidehemmelighet. Eksemplene laster ikke automatisk en .env-fil. Hold nøkkelen unna nettleserpakker, kildekontroll og offentlige nettadresser.
macOS / Linux-terminal
export GENDERAPI_API_KEY='YOUR_API_KEY'
Windows PowerShell
$env:GENDERAPI_API_KEY = 'YOUR_API_KEY'
Bekreft tilgang uten å bruke kreditter
Ring GET /usage med Bearer-overskriften. En gyldig kontonøkkel produserer meta.access.mode: api_key. Hvis resultatet sier ip_trial, sjekk den kopierte nøkkelen før du kjører spådommer. Denne forespørselen er gratis, inkludert for en konto uten gjenværende kreditt.
Velg et programmeringsspråk.Sett opp din API-nøkkel, kjør deretter eksemplet på serveren din.
Denne saldoavlesningen koster ingen kreditter. Det teller fortsatt mot forespørselsgrensene.
Før du kjører: tilgang og feilhåndtering
Kjør disse eksemplene på serveren din. Sett GENDERAPI_API_KEY i prosessmiljøet til din eksisterende API-nøkkel. Bekreft at meta.access.mode er api_key: en ukjent nøkkel kan falle tilbake til prøveversjonen av IP.
HTTP 4xx og 5xx JSON-svar bevarer feilteksten og returnerer en utgangsstatus som ikke er null. Sjekk code, action og meta.usage.billing_status før du prøver på nytt.
// Server-side Node.js. Save as example.mjs.const apiKey = process.env.GENDERAPI_API_KEY;if (!apiKey) throw new Error("Set GENDERAPI_API_KEY");const response = await fetch("https://api.genderapi.io/api/v2/usage", { method: "GET", headers: { Authorization: `Bearer ${apiKey}`, }, signal: AbortSignal.timeout(30_000), redirect: "error",});const raw = await response.text();if (!(response.headers.get("content-type") ?? "").includes("json")) { throw new Error(`HTTP ${response.status}: expected JSON; request ID ${response.headers.get("x-request-id")}`);}const result = JSON.parse(raw); // Also accepts application/problem+json.if (!response.ok) { console.error(`HTTP ${response.status}`, result); process.exitCode = 1; // A retry is a new operation; inspect billing first.} else { console.log(JSON.stringify(result, null, 2)); // For batches, inspect every item: HTTP 200 may contain item errors.}
Node.js 22+; innebygd henting. Lagre som example.mjs og kjør node example.mjs. Kjøretidsdokumentasjon
Python
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.
Python 3.10+; standard bibliotek. Lagre som example.py og kjør python3 example.py. Kjøretidsdokumentasjon
PHP 8+ med cURL-utvidelsen. Lagre som example.php og kjør php example.php. Kjøretidsdokumentasjon
Java
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+; standard HTTP-klient. Lagre som GenderApiExample.java og kjør java GenderApiExample.java. Kjøretidsdokumentasjon
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.}
.NET 8+ konsollapplikasjon. Bruk som Program.cs i et konsollprosjekt, og kjør deretter dotnet run. Kjøretidsdokumentasjon
Go
package mainimport ( "encoding/json" "fmt" "io" "net/http" "os" "strings" "time")func requiredEnv(name string) string { value := os.Getenv(name) if value == "" { panic("Set " + name) } return value}func run() error { apiKey := requiredEnv("GENDERAPI_API_KEY") request, err := http.NewRequest("GET", "https://api.genderapi.io/api/v2/usage", nil) if err != nil { return err } request.Header.Set("Authorization", "Bearer " + apiKey) client := &http.Client{ Timeout: 30 * time.Second, CheckRedirect: func(req *http.Request, via []*http.Request) error { return http.ErrUseLastResponse }, } response, err := client.Do(request) if err != nil { return err } defer response.Body.Close() raw, err := io.ReadAll(response.Body) if err != nil { return err } if !strings.Contains(response.Header.Get("Content-Type"), "json") || !json.Valid(raw) { return fmt.Errorf("HTTP %d: expected a JSON response", response.StatusCode) } if response.StatusCode < 200 || response.StatusCode >= 300 { return fmt.Errorf("HTTP %d: %s", response.StatusCode, raw) } fmt.Println(string(raw)) // For batches, inspect every item even on HTTP 200. return nil}func main() { if err := run(); err != nil { fmt.Fprintln(os.Stderr, err) // Keep Problem Details for error handling. os.Exit(1) }}
Go 1,22+; standard bibliotek. Lagre som main.go og kjør go run main.go. Kjøretidsdokumentasjon