ΤΕΚΜΗΡΙΩΣΗ API V2

GenderAPI.io V2: αναζήτηση με μικρό και πλήρες όνομα

Λάβετε προβλέψεις από ένα μικρό ή πλήρες όνομα με το GenderAPI.io V2. Χρησιμοποιήστε type: name και value, προαιρετικό πλαίσιο χώρας, κείμενο Unicode και την εφεδρική χρήση AI.

Πριν στείλετε το αίτημα

Στείλτε τα αιτήματα πρόβλεψης στο GenderAPI.io V2 με POST https://api.genderapi.io/api/v2/gender, με τα type και value στο σώμα JSON. Χρησιμοποιήστε το υπάρχον κλειδί GenderAPI.io σας σε Authorization: Bearer YOUR_API_KEY και Content-Type: application/json. Διαβάστε το αποτέλεσμα στο data και τις πληροφορίες πρόσβασης και χρέωσης στο meta. Κάθε αίτημα επεξεργάζεται ανεξάρτητα.

Επιλέξτε τη γλώσσα προγραμματισμού στο παράδειγμα κώδικα. Ορίστε το GENDERAPI_API_KEY στο περιβάλλον της διεργασίας πριν από την εκτέλεση. Τα κλειδιά που λείπουν ή δεν αναγνωρίζονται μπορεί να χρησιμοποιήσουν την κοινόχρηστη δοκιμαστική πρόσβαση IP. Γι' αυτό, όταν ενσωματώνετε έναν λογαριασμό, ελέγξτε ότι το meta.access.mode έχει την τιμή api_key.

Φύλο από όνομα

ΠαράμετροςΤύποςΥποχρεωτικόΠροεπιλογήΠεριγραφή
typestringΝαι—Κατηγορία εισόδου: name, email ή username.
valuestringΝαι—Υποχρεωτικό. 1–254 χαρακτήρες, όχι κενό και χωρίς χαρακτήρες ελέγχου. Οι τιμές email πρέπει να έχουν έγκυρη σύνταξη email.
countrystringΌχι—Προαιρετικός κωδικός ISO 3166-1 alpha-2 με κεφαλαία γράμματα, για παράδειγμα TR ή US. Μια αναζήτηση για συγκεκριμένη χώρα μπορεί να καταφύγει στο καθολικό σύνολο δεδομένων.
forceToGenderizebooleanΌχιfalseΕλέγχει πρώτα το σύνολο δεδομένων και, αν δεν υπάρξει αποτέλεσμα, χρησιμοποιεί AI με ανάλυση ψευδωνύμων. Υποστηρίζεται για name, email και username.
optionsobjectΌχι—Πεδίο με τις επιλογές AI για κάθε είσοδο.
options.ai_modestringΌχιfallbackΕπιτρεπόμενες τιμές: off, fallback, always. Με forceToGenderize: true, παραλείψτε αυτό το πεδίο ή χρησιμοποιήστε fallback.
idstringΌχι—Προαιρετικό αναγνωριστικό 1–64 χαρακτήρων στο JSON του POST. Επιστρέφεται δίπλα στο αντίστοιχο αποτέλεσμα της παρτίδας και πρέπει να είναι μοναδικό μέσα στην παρτίδα. Στις μεμονωμένες προβλέψεις γίνεται δεκτό, αλλά δεν επιστρέφεται. Δεν υποστηρίζεται στα ερωτήματα GET.

Για ένα μικρό ή πλήρες όνομα, στείλτε type: name και ολόκληρη την είσοδο στο value στο POST https://api.genderapi.io/api/v2/gender. Το GenderAPI.io V2 χρησιμοποιεί τα ίδια πεδία αιτήματος και για τις δύο μορφές. Ακόμη και μια επιτυχής απόκριση μπορεί να περιέχει data.gender: null. Τα μεμονωμένα αιτήματα ελέγχουν πρώτα το σύνολο δεδομένων και, από προεπιλογή, χρησιμοποιούν AI όταν από εκεί δεν είναι δυνατό να προσδιοριστεί φύλο.

Επιλέξτε γλώσσα προγραμματισμού. Ρυθμίστε το κλειδί 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 POST 'https://api.genderapi.io/api/v2/gender' \
  --header "Authorization: Bearer ${GENDERAPI_API_KEY:?Set GENDERAPI_API_KEY}" \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "name",
  "value": "Γιώργος",
  "country": "GR"
}'

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 body = {
  "type": "name",
  "value": "Γιώργος",
  "country": "GR"
};

const response = await fetch("https://api.genderapi.io/api/v2/gender", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${apiKey}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify(body),
  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")
body = json.loads("{\"type\":\"name\",\"value\":\"Γιώργος\",\"country\":\"GR\"}")

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/gender",
    method="POST",
    data=json.dumps(body).encode("utf-8"),
    headers={
        "Authorization": "Bearer " + api_key,
        "Content-Type": "application/json",
    },
)
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');
}
$body = json_decode('{"type":"name","value":"Γιώργος","country":"GR"}', true, 512, JSON_THROW_ON_ERROR);

$ch = curl_init('https://api.genderapi.io/api/v2/gender');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_FOLLOWLOCATION => false,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode($body, JSON_THROW_ON_ERROR),
]);
$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");
        String body = "{\"type\":\"name\",\"value\":\"Γιώργος\",\"country\":\"GR\"}";
        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/gender"))
            .timeout(Duration.ofSeconds(30))
            .header("Authorization", "Bearer " + apiKey)
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(body, StandardCharsets.UTF_8))
            .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.Post, "https://api.genderapi.io/api/v2/gender");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", apiKey);
request.Content = new StringContent("{\"type\":\"name\",\"value\":\"Γιώργος\",\"country\":\"GR\"}", Encoding.UTF8, "application/json");

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")
    body := "{\"type\":\"name\",\"value\":\"Γιώργος\",\"country\":\"GR\"}"
    request, err := http.NewRequest("POST", "https://api.genderapi.io/api/v2/gender", strings.NewReader(body))
    if err != nil { return err }
    request.Header.Set("Authorization", "Bearer " + apiKey)
    request.Header.Set("Content-Type", "application/json")
    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. Τεκμηρίωση του περιβάλλοντος εκτέλεσης

Παράδειγμα απόκρισης

Αυτή είναι μια πραγματική απόκριση που λήφθηκε την 1η Οκτωβρίου 2026 με κλειδί API. Αντικαταστάθηκε μόνο το υπόλοιπο του λογαριασμού. Δεν αποτελεί μέτρο ακρίβειας και ένα αίτημα σε πραγματικό χρόνο μπορεί να επιστρέψει διαφορετικό αποτέλεσμα. Τα αιτήματα με κλειδί API επιστρέφουν meta.access.mode: api_key και null στα πεδία ορίου που ισχύουν μόνο για τη δοκιμαστική πρόσβαση, ενώ τα αιτήματα μέσω της δοκιμαστικής πρόσβασης IP επιστρέφουν ip_trial. Διαβάστε το data για την πρόβλεψη και το meta.usage για το αποτέλεσμα της χρέωσης της λειτουργίας.

Παράδειγμα απόκρισης JSON
{
  "data": {
    "input": {
      "type": "name",
      "value": "Γιώργος",
      "country": "GR"
    },
    "name": "γιώργος",
    "gender": "male",
    "country": "GR",
    "confidence": 0.9958419958419958,
    "confidence_kind": "observed_frequency",
    "sample_count": 481,
    "source": "dataset",
    "result_status": "identified",
    "reason": null,
    "country_source": "dataset",
    "match": {
      "name": "γιώργος",
      "method": "normalized",
      "scope": "country",
      "country": "GR"
    }
  },
  "meta": {
    "request_id": "6e0323de-a249-46fe-88fc-9d60bfd59bd3",
    "duration_ms": 10,
    "access": {
      "mode": "api_key",
      "reason": null
    },
    "usage": {
      "charged_credits": 1,
      "remaining_credits": 49999,
      "billing_status": "confirmed",
      "resets_at": null,
      "limit": null,
      "period_seconds": null
    }
  }
}

Πεδία απόκρισης πρόβλεψης

ΠεδίοΤύποςΜπορεί να είναι nullΠαράδειγμαΠεριγραφή
data.inputobjectΌχι{"type":"name","value":"Γιώργος","country":"GR"}Τύπος εισόδου, τιμή και χώρα. Το forceToGenderize περιλαμβάνεται όταν είναι true.
data.namestringΝαι"γιώργος"Μικρό όνομα που αντιστοιχίστηκε ή εξήχθη. null όταν δεν είναι διαθέσιμο.
data.genderstringΝαι"male"male, female ή JSON null. Πρόκειται για πρόβλεψη, όχι για επαληθευμένη ταυτότητα ενός ατόμου.
data.result_statusstringΌχι"identified"identified όταν επιστρέφεται φύλο, διαφορετικά unknown.
data.reasonstringΝαιnullnull για τα αποτελέσματα identified. Λόγοι για unknown: not_found, no_name_candidate, ambiguous ή insufficient_evidence.
data.confidencenumberΝαι0.95Τιμή από 0 έως 1 ή null. Όταν το gender είναι null, και ο βαθμός βεβαιότητας είναι null.
data.confidence_kindstringΝαι"observed_frequency"observed_frequency: το πλήθος της επικρατέστερης κατηγορίας στο σύνολο δεδομένων διαιρεμένο με το συνολικό πλήθος. model_reported: τιμή που αναφέρει το AI, όχι βαθμονομημένη πιθανότητα. null όταν δεν είναι διαθέσιμη.
data.sample_countintegerΝαι1200Μέγεθος δείγματος στο σύνολο δεδομένων ή null. Το AI δεν επινοεί πλήθος δειγμάτων.
data.sourcestringΌχι"dataset"dataset, ai ή none.
data.countrystringΝαι"GR"Συσχέτιση χώρας από dataset ή ai_association ή null. Δεν καθορίζει εθνικότητα, τόπο κατοικίας ούτε εθνοτική καταγωγή.
data.country_sourcestringΝαι"dataset"Προέλευση της συσχέτισης χώρας: dataset, ai_association ή null.
data.matchobjectΌχι{"name":"γιώργος","method":"normalized","scope":"country","country":"GR"}Όνομα που αντιστοιχίστηκε στο σύνολο δεδομένων, μέθοδος (normalized, token, substring ή model_inference), εύρος country ή global και χώρα της αντιστοίχισης. Τα τεκμήρια που δεν είναι διαθέσιμα είναι null.

Μεταδεδομένα πρόσβασης, χρέωσης και αιτήματος

ΠεδίοΤύποςΜπορεί να είναι nullΠαράδειγμαΠεριγραφή
meta.request_idstringΌχι"550e8400-e29b-41d4-a716-446655440000"Μοναδικό αναγνωριστικό αυτής της απόπειρας HTTP. Αποστέλλεται και στο X-Request-ID.
meta.duration_msintegerΌχι42Χρόνος επεξεργασίας του αιτήματος σε χιλιοστά του δευτερολέπτου.
meta.access.modestringΌχι"api_key"api_key, ip_trial ή unauthenticated. Με λογαριασμό επί πληρωμή ελέγξτε ότι επιστρέφεται api_key.
meta.access.reasonstringΝαιnullΛόγος μετάβασης στη δοκιμαστική πρόσβαση IP: api_key_missing, api_key_invalid ή api_key_not_found. Διαφορετικά null.
meta.usage.charged_creditsintegerΝαι1Καθαρές πιστώσεις που χρεώθηκαν. Μηδέν πριν από τη χρέωση ή μετά από πλήρη επιβεβαιωμένη επιστροφή πιστώσεων. null όταν η χρέωση δεν έχει επιβεβαιωθεί.
meta.usage.remaining_creditsintegerΝαι99Υπόλοιπο κατά την ολοκλήρωση της λειτουργίας. Μπορεί να είναι αρνητικό. null αν δεν είναι διαθέσιμο ή αν η χρέωση δεν έχει επιβεβαιωθεί.
meta.usage.billing_statusstringΌχι"confirmed"not_charged, confirmed ή unconfirmed. Ελέγξτε το πριν επαναλάβετε μια πρόβλεψη που απέτυχε.
meta.usage.resets_atstringΝαι"2026-09-27T12:00:00.000Z"Χρονική στιγμή επαναφοράς της δοκιμαστικής πρόσβασης IP σε UTC (ISO 8601). null για λογαριασμούς με κλειδί API ή όταν είναι άγνωστη.
meta.usage.limitintegerΝαι10Όριο πιστώσεων της δοκιμαστικής πρόσβασης IP. null για λογαριασμούς με κλειδί API.
meta.usage.period_secondsintegerΝαι86400Διάρκεια της περιόδου της δοκιμαστικής πρόσβασης IP σε δευτερόλεπτα. null για λογαριασμούς με κλειδί API.

Πλαίσιο χώρας και άγνωστα ονόματα

Δώστε country μόνο όταν διαθέτετε σχετικό πλαίσιο. Το API μπορεί να επιλέξει μια γραμμή του συνόλου δεδομένων για τη συγκεκριμένη χώρα ή να καταφύγει σε μια καθολική γραμμή. Το data.match.scope δείχνει ποια επιλέχθηκε. Η χώρα που επιστρέφεται δεν καθορίζει πού ζει το άτομο.

Από προεπιλογή τα μεμονωμένα αιτήματα χρησιμοποιούν την εφεδρική χρήση AI, με συνολικό κόστος 1 πίστωση. Για να χρησιμοποιήσετε μόνο το σύνολο δεδομένων, στείλτε options: {"ai_mode": "off"}. Οι είσοδοι χωρίς αποτέλεσμα μπορεί να επιστρέψουν gender: null και χρεώνονται κανονικά όταν η λειτουργία ολοκληρώνεται επιτυχώς. Ένα πλήρες όνομα μπορεί να αντιστοιχιστεί μέσω ενός από τα μέρη του. Το data.match καταγράφει τον υποψήφιο που επιλέχθηκε και τη μέθοδο αντιστοίχισης.

Για τιμές τύπου name που μοιάζουν με ψευδώνυμο, το forceToGenderize: true επιτρέπει πρόβλεψη χωρίς πραγματικό μικρό όνομα. Ένα αποτέλεσμα από το σύνολο δεδομένων κοστίζει 1 πίστωση, διαφορετικά το AI με ανάλυση ψευδωνύμων κοστίζει συνολικά 2 πιστώσεις. Αρκεί ένα θετικό αρχικό υπόλοιπο και το τελικό υπόλοιπο μπορεί να γίνει αρνητικό.

Αναζήτηση πλήρους ονόματος χωρίς να θεωρείτε δεδομένο ότι μετρά η πρώτη λέξη

Στείλτε το αρχικό όνομα σε Unicode. Η αντιστοίχιση με το σύνολο δεδομένων χρησιμοποιεί κανονικοποίηση NFKC, πεζά γράμματα και εξαγωγή των μερών του ονόματος, επομένως δεν χρειάζεται να μετατρέψετε το όνομα σε ASCII. Από τους διαθέσιμους υποψηφίους, το API επιλέγει την εγγραφή του συνόλου δεδομένων με το υψηλότερο αποθηκευμένο συνολικό πλήθος. Ο υποψήφιος μπορεί να είναι ένα μεταγενέστερο μέρος του ονόματος, γι' αυτό μη θεωρείτε δεδομένο ότι επιλέχθηκε η πρώτη λέξη ή το μικρό όνομα.

Αυτό το αίτημα χρησιμοποιεί μόνο το σύνολο δεδομένων, ώστε να ελέγχονται πιο εύκολα τα τεκμήρια που επιλέχθηκαν. Διαβάστε το data.input.value για το πλήρες όνομα που στάλθηκε, το data.match.name για τον υποψήφιο που αναζητήθηκε και το data.match.method για τη μέθοδο αντιστοίχισης. Το παράδειγμα δεν υπόσχεται συγκεκριμένο φύλο ούτε συγκεκριμένο μέρος του ονόματος. Οι υποψήφιοι του συνόλου δεδομένων πρέπει να έχουν περισσότερους από δύο χαρακτήρες και οι σύντομες είσοδοι μπορεί να μείνουν χωρίς αποτέλεσμα. Χρησιμοποιήστε την κανονική εφεδρική χρήση AI όταν η πρόσθετη πρόβλεψη είναι κατάλληλη για την εφαρμογή σας.

Επιλέξτε γλώσσα προγραμματισμού. Ρυθμίστε το κλειδί 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 POST 'https://api.genderapi.io/api/v2/gender' \
  --header "Authorization: Bearer ${GENDERAPI_API_KEY:?Set GENDERAPI_API_KEY}" \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "name",
  "value": "Ayşe Yılmaz",
  "country": "TR",
  "options": {
    "ai_mode": "off"
  }
}'

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 body = {
  "type": "name",
  "value": "Ayşe Yılmaz",
  "country": "TR",
  "options": {
    "ai_mode": "off"
  }
};

const response = await fetch("https://api.genderapi.io/api/v2/gender", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${apiKey}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify(body),
  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")
body = json.loads("{\"type\":\"name\",\"value\":\"Ayşe Yılmaz\",\"country\":\"TR\",\"options\":{\"ai_mode\":\"off\"}}")

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/gender",
    method="POST",
    data=json.dumps(body).encode("utf-8"),
    headers={
        "Authorization": "Bearer " + api_key,
        "Content-Type": "application/json",
    },
)
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');
}
$body = json_decode('{"type":"name","value":"Ayşe Yılmaz","country":"TR","options":{"ai_mode":"off"}}', true, 512, JSON_THROW_ON_ERROR);

$ch = curl_init('https://api.genderapi.io/api/v2/gender');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_FOLLOWLOCATION => false,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode($body, JSON_THROW_ON_ERROR),
]);
$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");
        String body = "{\"type\":\"name\",\"value\":\"Ayşe Yılmaz\",\"country\":\"TR\",\"options\":{\"ai_mode\":\"off\"}}";
        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/gender"))
            .timeout(Duration.ofSeconds(30))
            .header("Authorization", "Bearer " + apiKey)
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(body, StandardCharsets.UTF_8))
            .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.Post, "https://api.genderapi.io/api/v2/gender");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", apiKey);
request.Content = new StringContent("{\"type\":\"name\",\"value\":\"Ayşe Yılmaz\",\"country\":\"TR\",\"options\":{\"ai_mode\":\"off\"}}", Encoding.UTF8, "application/json");

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")
    body := "{\"type\":\"name\",\"value\":\"Ayşe Yılmaz\",\"country\":\"TR\",\"options\":{\"ai_mode\":\"off\"}}"
    request, err := http.NewRequest("POST", "https://api.genderapi.io/api/v2/gender", strings.NewReader(body))
    if err != nil { return err }
    request.Header.Set("Authorization", "Bearer " + apiKey)
    request.Header.Set("Content-Type", "application/json")
    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. Τεκμηρίωση του περιβάλλοντος εκτέλεσης

Έλεγχος του πλαισίου χώρας που πράγματι συνέβαλε

Χρησιμοποιήστε κωδικό χώρας ISO μόνο όταν διαθέτετε σχετικό πλαίσιο. Μην τον συνάγετε από το αποτέλεσμα που προβλέφθηκε. Για κάθε υποψήφιο, μια υπάρχουσα γραμμή χώρας έχει προτεραιότητα έναντι της καθολικής γραμμής του ίδιου υποψηφίου. Αν δεν υπάρχει γραμμή χώρας, ο υποψήφιος μπορεί να χρησιμοποιήσει μια καθολική γραμμή. Μια γραμμή χώρας με ισοπαλία δεν αντικαθίσταται από την καθολική της γραμμή. Αν η επιλεγμένη γραμμή έχει ισοπαλία, το αποτέλεσμα του συνόλου δεδομένων είναι unknown και μπορεί να ακολουθήσει ενεργοποιημένη εφεδρική χρήση AI.

Τεκμήριο στην απόκρισηΕρμηνείαΕνέργεια στην εφαρμογή
match.scope: country, match.country: TRΟ υποψήφιος που επιλέχθηκε στο σύνολο δεδομένων προέρχεται από τη γραμμή της χώρας που δόθηκε στο αίτημα.Αποθηκεύστε τον υποψήφιο που επιλέχθηκε και το εύρος χώρας μαζί με την πρόβλεψη.
match.scope: global, match.country: nullΟ υποψήφιος που επιλέχθηκε προέρχεται από καθολική γραμμή, ακόμη κι αν το αίτημα όριζε χώρα.Μη σημειώνετε το αποτέλεσμα ως αντιστοίχιση για τη συγκεκριμένη χώρα.
country_source: dataset ή ai_associationΕξηγεί την προέλευση του data.country, όχι το εύρος της αναζήτησης στο σύνολο δεδομένων ούτε την εθνικότητα του ατόμου.Διαβάστε αυτό το πεδίο ξεχωριστά από το match.country. Κανένα από τα δύο δεν επιβεβαιώνει τόπο κατοικίας ή εθνικότητα.
source: ai, match.scope: nullΗ τελική απόκριση προέρχεται από το AI, επομένως δεν περιέχει επιλεγμένη γραμμή του συνόλου δεδομένων.Ακολουθήστε τις οδηγίες για τον βαθμό βεβαιότητας των αποτελεσμάτων AI και διατηρήστε τα άγνωστα αποτελέσματα.

Σχετικοί οδηγοί