अपनी मौजूदा API कुंजी के साथ GenderAPI v2 को प्रमाणित करें। Bearer हेडर, GET क्वेरी कुंजियाँ, IP ट्रायल एक्सेस और JSON अनुरोध सीखें।
प्रमाणीकरण और निःशुल्क परीक्षण
अपने सर्वर से Authorization: Bearer YOUR_API_KEY भेजें। YOUR_API_KEY को अपनी मौजूदा GenderAPI कुंजी से बदलें। दोनों संस्करण आपका संतुलन साझा करते हैं; किसी अलग v2 सदस्यता या कुंजी की आवश्यकता नहीं है।
सभी POST अनुरोधों के लिए Content-Type: application/json की आवश्यकता होती है। अपनी मौजूदा Bearer API कुंजी का उपयोग करें। प्रत्येक अनुरोध स्वतंत्र रूप से संसाधित किया जाता है; बार-बार अनुरोध करने पर सामान्य बिलिंग का उपयोग होता है।
केवल GET /gender भी मुख्य क्वेरी पैरामीटर को स्वीकार करता है। एकीकरण के लिए प्राधिकरण शीर्षलेख को प्राथमिकता दें क्योंकि यूआरएल को ब्राउज़र इतिहास और लॉग में संग्रहीत किया जा सकता है। फ़्रंटएंड कोड में निजी कुंजी न डालें.
यदि कोई एपीआई कुंजी गुम है, उसका प्रारूप अमान्य है या पहचाना नहीं गया है, तो अनुरोध v1 के साथ साझा किए गए आईपी परीक्षण का उपयोग करता है। यह उन मान्यताप्राप्त कुंजियों पर लागू नहीं होता जो अक्षम, समाप्त या प्रतिबंधित हैं। meta.access.mode में एक्सेस मोड की जाँच करें: api_key, ip_trial या unauthenticated। परीक्षण का कारण api_key_missing, api_key_invalid या api_key_not_found है। इसलिए एक अमान्य कुंजी अभी भी एक सफल परीक्षण प्रतिक्रिया प्राप्त कर सकती है। उत्पादन में एक्सेस मोड सत्यापित करें.
ट्रायल क्रेडिट 24 घंटे की अवधि के बाद रीसेट हो जाते हैं, जरूरी नहीं कि आधी रात को। resets_at पढ़ने के लिए /usage का उपयोग करें। समान सार्वजनिक IP के पीछे के लोग इस भत्ते को साझा करते हैं।
अपने GenderAPI खाते से अपनी API कुंजी कॉपी करें। नीचे दिए गए YOUR_API_KEY को उस कुंजी से बदलें, फिर अपना चुना हुआ उदाहरण उसी टर्मिनल सत्र में चलाएं। ये आदेश केवल उस सत्र के लिए एक पर्यावरण चर निर्धारित करते हैं; प्रकाशित प्लेसहोल्डर एक कार्यशील कुंजी नहीं है.
किसी एप्लिकेशन या परिनियोजन के लिए, GENDERAPI_API_KEY को सर्वर-साइड सीक्रेट के रूप में कॉन्फ़िगर करें। उदाहरण स्वचालित रूप से .env फ़ाइल लोड नहीं करते हैं। कुंजी को ब्राउज़र बंडलों, स्रोत नियंत्रण और सार्वजनिक यूआरएल से दूर रखें।
macOS/लिनक्स टर्मिनल
export GENDERAPI_API_KEY='YOUR_API_KEY'
Windows PowerShell
$env:GENDERAPI_API_KEY = 'YOUR_API_KEY'
क्रेडिट खर्च किए बिना पहुंच सत्यापित करें
Bearer हेडर के साथ GET /usage पर कॉल करें। एक वैध खाता कुंजी meta.access.mode: api_key उत्पन्न करती है। यदि परिणाम ip_trial कहता है, तो पूर्वानुमान चलाने से पहले कॉपी की गई कुंजी की जांच करें। यह अनुरोध मुफ़्त है, जिसमें ऐसे खाते के लिए भी शामिल है जिसमें कोई शेष क्रेडिट नहीं है।
इस शेष राशि को पढ़ने पर कोई क्रेडिट नहीं होता है। यह अभी भी अनुरोध दर सीमा में गिना जाता है।
चलाने से पहले: पहुंच और त्रुटि प्रबंधन
इन उदाहरणों को अपने सर्वर पर चलाएँ। प्रक्रिया परिवेश में GENDERAPI_API_KEY को अपनी मौजूदा API कुंजी पर सेट करें। पुष्टि करें कि meta.access.mode api_key है: एक अपरिचित कुंजी IP परीक्षण में वापस आ सकती है।
HTTP 4xx और 5xx JSON प्रतिक्रियाएँ त्रुटि निकाय को संरक्षित करती हैं और एक गैर-शून्य निकास स्थिति लौटाती हैं। पुनः प्रयास करने से पहले code, action और meta.usage.billing_status की जाँच करें।
// 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+; अंतर्निर्मित फ़ेच. example.mjs के रूप में सहेजें और node example.mjs चलाएँ। रनटाइम दस्तावेज़ीकरण
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+; मानक पुस्तकालय. example.py के रूप में सहेजें और python3 example.py चलाएँ। रनटाइम दस्तावेज़ीकरण
PHP 8+ cURL एक्सटेंशन के साथ. example.php के रूप में सहेजें और php example.php चलाएँ। रनटाइम दस्तावेज़ीकरण
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+; मानक HTTP क्लाइंट. GenderApiExample.java के रूप में सहेजें और java GenderApiExample.java चलाएँ। रनटाइम दस्तावेज़ीकरण
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+ कंसोल एप्लिकेशन. कंसोल प्रोजेक्ट में Program.cs के रूप में उपयोग करें, फिर dotnet run चलाएँ। रनटाइम दस्तावेज़ीकरण
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+; मानक पुस्तकालय. main.go के रूप में सहेजें और go run main.go चलाएँ। रनटाइम दस्तावेज़ीकरण