เอกสาร API V2

การยืนยันตัวตนและการทดลองใช้ฟรีของ API V2

ยืนยันตัวตนกับ GenderAPI.io V2 ด้วยคีย์ API ที่มีอยู่ เรียนรู้การใช้ส่วนหัว Bearer คีย์ในคิวรีของ GET การเข้าถึงแบบทดลองใช้ตาม IP และคำขอ JSON

การยืนยันตัวตนและการทดลองใช้ฟรี

พารามิเตอร์ชนิดข้อมูลจำเป็นค่าเริ่มต้นคำอธิบาย
Authorizationstringไม่—ส่ง Bearer YOUR_API_KEY เพื่อใช้บัญชี หากไม่มีคีย์หรือระบบไม่รู้จักคีย์ จะใช้การทดลองใช้ตาม IP ที่ใช้ร่วมกัน
Content-Typestringเฉพาะ POST—ส่ง application/json สำหรับคำขอ POST

ส่ง Authorization: Bearer YOUR_API_KEY จากเซิร์ฟเวอร์ของคุณ แทนที่ YOUR_API_KEY ด้วยคีย์ GenderAPI.io ที่คุณมีอยู่ ทั้งสองเวอร์ชันใช้ยอดคงเหลือร่วมกัน จึงไม่ต้องสมัครแพ็กเกจหรือสร้างคีย์แยกสำหรับ V2

คำขอ POST ทั้งหมดต้องใช้ Content-Type: application/json ใช้คีย์ API แบบ Bearer ที่มีอยู่ คำขอแต่ละรายการได้รับการประมวลผลแยกกัน และคำขอที่ส่งซ้ำจะถูกหักเครดิตตามปกติ

มีเพียง GET /gender เท่านั้นที่รับพารามิเตอร์คิวรี key ได้ด้วย สำหรับการเชื่อมต่อควรใช้ส่วนหัว Authorization เพราะ URL อาจถูกเก็บไว้ในประวัติเบราว์เซอร์และล็อก อย่าใส่คีย์ส่วนตัวไว้ในโค้ดฝั่งฟรอนต์เอนด์

หากไม่มีคีย์ คีย์ผิดรูปแบบ หรือระบบไม่รู้จักคีย์ คำขอจะใช้การทดลองใช้ตาม IP ที่ใช้ร่วมกับ V1 แทน แต่คีย์ที่ระบบรู้จักซึ่งถูกปิดใช้งาน หมดอายุ หรือถูกจำกัดจะไม่ใช้การทดลองใช้แทน ตรวจสอบ meta.access.mode ว่าเป็น api_key, ip_trial หรือ unauthenticated เหตุผลที่ใช้การทดลองใช้คือ api_key_missing, api_key_invalid หรือ api_key_not_found ดังนั้นคีย์ที่ไม่ถูกต้องอาจยังได้รับการตอบกลับที่สำเร็จจากการทดลองใช้ ควรตรวจสอบโหมดการเข้าถึงในระบบใช้งานจริง

เครดิตทดลองใช้จะรีเซ็ตเมื่อครบรอบ 24 ชั่วโมง ไม่จำเป็นต้องเป็นเวลาเที่ยงคืน ใช้ /usage เพื่ออ่าน resets_at ผู้ใช้ที่อยู่หลัง IP สาธารณะเดียวกันจะใช้เครดิตทดลองใช้นี้ร่วมกัน

ตั้งค่าคีย์ API

คัดลอกคีย์ API จากบัญชี GenderAPI.io ของคุณ แทนที่ YOUR_API_KEY ด้านล่างด้วยคีย์นั้น แล้วรันตัวอย่างที่เลือกในเซสชันเทอร์มินัลเดียวกัน คำสั่งเหล่านี้ตั้งค่าตัวแปรสภาพแวดล้อมสำหรับเซสชันนั้นเท่านั้น ค่าตัวอย่างที่แสดงไว้ไม่ใช่คีย์ที่ใช้งานได้

สำหรับแอปพลิเคชันหรือการนำระบบขึ้นใช้งาน ให้กำหนด GENDERAPI_API_KEY เป็นข้อมูลลับฝั่งเซิร์ฟเวอร์ ตัวอย่างไม่ได้โหลดไฟล์ .env โดยอัตโนมัติ อย่าให้คีย์อยู่ในไฟล์ที่ส่งไปยังเบราว์เซอร์ ระบบควบคุมซอร์สโค้ด หรือ URL สาธารณะ

เทอร์มินัล macOS / Linux
export GENDERAPI_API_KEY='YOUR_API_KEY'
Windows PowerShell
$env:GENDERAPI_API_KEY = 'YOUR_API_KEY'

ตรวจสอบการเข้าถึงโดยไม่ใช้เครดิต

เรียก GET /usage พร้อมส่วนหัว Bearer คีย์ API ของบัญชีที่ถูกต้องจะให้ผลเป็น meta.access.mode: api_key หากผลลัพธ์แสดง ip_trial ให้ตรวจสอบคีย์ที่คัดลอกมาก่อนส่งคำขอคาดการณ์ คำขอนี้ใช้ฟรี แม้บัญชีจะไม่มีเครดิตเหลือแล้วก็ตาม

เลือกภาษาโปรแกรม ตั้งค่าคีย์ API จากนั้นรันตัวอย่างบนเซิร์ฟเวอร์ของคุณ

การอ่านยอดคงเหลือนี้ไม่ใช้เครดิต แต่ยังนับรวมในขีดจำกัดคำขอ

ก่อนรัน: การเข้าถึงและการจัดการข้อผิดพลาด

รันตัวอย่างเหล่านี้บนเซิร์ฟเวอร์ของคุณ ตั้งค่า GENDERAPI_API_KEY ในสภาพแวดล้อมของโปรเซสเป็นคีย์ API ที่มีอยู่ ตรวจสอบว่า meta.access.mode เป็น api_key เพราะคีย์ที่ระบบไม่รู้จักอาจทำให้ใช้การทดลองใช้ตาม IP แทน

การตอบกลับ JSON ที่มี HTTP 4xx และ 5xx จะคงเนื้อหาข้อผิดพลาดไว้และจบด้วยสถานะการออกที่ไม่ใช่ศูนย์ ตรวจสอบ code, action และ meta.usage.billing_status ก่อนส่งคำขอซ้ำ

คู่มือข้อผิดพลาดและการส่งคำขอซ้ำ →
cURL
curl --silent --show-error --fail-with-body --max-time 30 \
  --request GET 'https://api.genderapi.io/api/v2/usage' \
  --header "Authorization: Bearer ${GENDERAPI_API_KEY:?Set GENDERAPI_API_KEY}"

cURL 7.76+ ในเชลล์ POSIX รันในเทอร์มินัล เอกสารของรันไทม์

JavaScript / Node.js
// 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+ พร้อม fetch ในตัว บันทึกเป็น example.mjs แล้วรัน node example.mjs เอกสารของรันไทม์

Python
import json
import os
import sys
import urllib.error
import urllib.request

api_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 None

request = 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
<?php
$apiKey = getenv('GENDERAPI_API_KEY');
if (!$apiKey) {
    throw new RuntimeException('Set GENDERAPI_API_KEY');
}

$ch = curl_init('https://api.genderapi.io/api/v2/usage');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_FOLLOWLOCATION => false,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
    ],
]);
$raw = curl_exec($ch);
if ($raw === false) {
    throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
$contentType = curl_getinfo($ch, CURLINFO_CONTENT_TYPE) ?: '';
curl_close($ch);
if (strpos($contentType, 'json') === false) {
    throw new RuntimeException("HTTP $status: expected a JSON response");
}
$result = json_decode($raw, true, 512, JSON_THROW_ON_ERROR);
$output = json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR) . PHP_EOL;
if ($status < 200 || $status >= 300) {
    fwrite(STDERR, $output); // Preserve the Problem Details body.
    exit(1);
}
echo $output;
// For batches, inspect every item; HTTP 200 can contain item errors.

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 main

import (
    "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 เอกสารของรันไทม์

ขั้นตอนถัดไป