KuvausLähetä Bearer YOUR_API_KEY, jos käytät tiliä. Puuttuva tai tuntematon avain käyttää yhteistä IP-kokeilua.
ParametriContent-Type
Tyyppistring
PakollinenVain POST
Oletusarvo—
KuvausLähetä POST-pyynnöissä application/json.
Lähetä palvelimeltasi otsake Authorization: Bearer YOUR_API_KEY. Korvaa YOUR_API_KEY nykyisellä GenderAPI-avaimellasi. Molemmat versiot käyttävät samaa saldoa; erillistä V2-tilausta tai -avainta ei tarvita.
Kaikki POST-pyynnöt edellyttävät otsaketta Content-Type: application/json. Käytä nykyistä API-avaintasi Bearer-otsakkeessa. Jokainen pyyntö käsitellään erikseen, ja toistetut pyynnöt laskutetaan normaalisti.
Vain GET /gender hyväksyy myös key-kyselyparametrin. Käytä integraatioissa mieluummin Authorization-otsaketta, koska URL-osoitteet voivat tallentua selainhistoriaan ja lokeihin. Älä sijoita yksityisiä avaimia selainpuolen koodiin.
Jos API-avain puuttuu, sen muoto on virheellinen tai sitä ei tunnisteta, pyyntö käyttää V1:n kanssa jaettua IP-kokeilua. Tämä ei koske tunnistettuja avaimia, jotka on poistettu käytöstä, jotka ovat vanhentuneet tai joita on rajoitettu. Tarkista käyttötila kentästä meta.access.mode: api_key, ip_trial tai unauthenticated. Kokeilun syy on api_key_missing, api_key_invalid tai api_key_not_found. Virheellinen avain voi siis tuottaa onnistuneen kokeiluvastauksen; tarkista käyttötila tuotannossa.
Kokeilukrediitit nollautuvat 24 tunnin jakson jälkeen, eivät välttämättä keskiyöllä. Lue resets_at reitiltä /usage. Saman julkisen IP-osoitteen takana olevat käyttäjät jakavat tämän kiintiön.
Kopioi API-avain GenderAPI-tililtäsi. Korvaa alla oleva YOUR_API_KEY tällä avaimella ja suorita valitsemasi esimerkki samassa pääteistunnossa. Komennot asettavat ympäristömuuttujan vain kyseiseen istuntoon; julkaistu paikkamerkki ei ole toimiva avain.
Määritä sovelluksessa tai tuotantoympäristössä GENDERAPI_API_KEY palvelinpuolen salaisuudeksi. Esimerkit eivät lataa .env-tiedostoa automaattisesti. Pidä avain poissa selainpaketeista, versionhallinnasta ja julkisista URL-osoitteista.
macOS- ja Linux-pääte
export GENDERAPI_API_KEY='YOUR_API_KEY'
Windows PowerShell
$env:GENDERAPI_API_KEY = 'YOUR_API_KEY'
Tarkista käyttöoikeus kuluttamatta krediittejä
Kutsu GET /usage Bearer-otsakkeen kanssa. Kelvollinen tiliavain tuottaa arvon meta.access.mode: api_key. Jos tulos on ip_trial, tarkista kopioimasi avain ennen ennusteiden suorittamista. Pyyntö on maksuton myös tilille, jolla ei ole krediittejä jäljellä.
Valitse ohjelmointikieli.Määritä API-avain, suorita sitten esimerkki palvelimellasi.
Saldon lukeminen ei kuluta krediittejä, mutta se lasketaan pyyntöjen määrärajoihin.
Ennen suorittamista: käyttöoikeus ja virheiden käsittely
Suorita esimerkit palvelimellasi. Aseta prosessin ympäristömuuttujan GENDERAPI_API_KEY arvoksi nykyinen API-avaimesi. Varmista, että meta.access.mode on api_key: tunnistamaton avain voi siirtää pyynnön IP-kokeiluun.
HTTP 4xx- ja 5xx-JSON-vastauksissa esimerkit säilyttävät virherungon ja palauttavat nollasta poikkeavan poistumiskoodin. Tarkista code, action ja meta.usage.billing_status ennen uutta yritystä.
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+; standardikirjaston HTTP-asiakas. Tallenna nimellä GenderApiExample.java ja suorita java GenderApiExample.java. Suoritusympäristön dokumentaatio
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+ -konsolisovellus. Käytä konsoliprojektissa nimellä Program.cs ja suorita sitten dotnet run. Suoritusympäristön dokumentaatio
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) }}