Oficjalne SDK GenderAPI.io V2

Wybierz pakiet

Oficjalne SDK open source wywołują to samo API V2, które opisują te przewodniki. Wersja 2.x każdego pakietu korzysta z API V2. W nowych projektach instaluj linię 2.x.

Język	Pakiet	Instalacja	Wymagania
Python	`genderapi (PyPI)`	`pip install "genderapi>=2,<3"`	Python 3.9+
JavaScript / TypeScript	`genderapi (npm)`	`npm install genderapi@2`	Node.js 18+
PHP	`genderapi/genderapi (Packagist)`	`composer require "genderapi/genderapi:^2.0"`	PHP 8.1+
Ruby	`genderapi (RubyGems)`	`gem install genderapi -v "~> 2.0"`	Ruby 3.0+
Java	`com.github.GenderAPI:genderapi-java (JitPack)`	`implementation 'com.github.GenderAPI:genderapi-java:v2.0.0'`	Java 11+
R	`genderapi (GitHub)`	`remotes::install_github("GenderAPI/genderapi-R", ref = "v2.0.0")`	R 4.1+
C# / .NET	`GenderAPI (NuGet)`	`dotnet add package GenderAPI`	.NET 8 lub .NET Standard 2.0

Uwagi dotyczące rejestrów pakietów

Java: dodaj https://jitpack.io do swoich repozytoriów. To samo wydanie jest też publikowane w GitHub Packages jako io.genderapi:genderapi, co wymaga tokenu GitHub z uprawnieniem read:packages.
R: CRAN nadal udostępnia pakiet 1.x, dopóki wersja 2.0.0 przechodzi przegląd w CRAN. Do czasu publikacji w CRAN instaluj wersję 2.0.0 z tagu w GitHub.
JavaScript: pakiet jest przeznaczony dla środowisk uruchomieniowych po stronie serwera. Nie używaj go w kodzie przeglądarki, ponieważ ujawniłoby to Twój klucz API.

Wspólne zachowanie

Każdy klient odczytuje klucz API ze zmiennej GENDERAPI_API_KEY lub przyjmuje go w konstruktorze. Przechowuj klucz na swoim serwerze.
Bez klucza API zapytania korzystają ze współdzielonej próby dla adresu IP: 10 kredytów na adres IP w ciągu 24 godzin.
Import pakietu ani utworzenie klienta nie wysyła żadnego zapytania. Każde wywołanie metody wysyła dokładnie jedno zapytanie.
Żaden SDK nie ponawia zapytań automatycznie. Ponowienie to nowa operacja rozliczana normalnie, dlatego najpierw sprawdź błąd i status rozliczenia.
SDK nie podążają za przekierowaniami, a domyślny limit czasu wynosi 10 sekund.
Wynik nieznany jest udaną odpowiedzią: gender ma wartość null, a zapytanie jest rozliczane normalnie.
Błędy udostępniają status HTTP, kod błędu, identyfikator zapytania oraz, jeśli występuje, wartość Retry-After.

Przykłady szybkiego startu

Każdy przykład wysyła jedno zapytanie o prognozę dla imienia i kosztuje 1 kredyt. Najpierw ustaw GENDERAPI_API_KEY w środowisku serwera. README każdego repozytorium opisuje zapytania wsadowe, sprawdzanie wykorzystania i obsługę błędów.

from genderapi import GenderAPI

client = GenderAPI()  # reads GENDERAPI_API_KEY
result = client.name("Alice", country="US")
print(result.data.gender, result.data.result_status)
print(result.meta.usage.charged_credits)

import { GenderAPI } from "genderapi";

const client = new GenderAPI(); // reads GENDERAPI_API_KEY
const { data, meta } = await client.name("Andrea", { country: "IT" });
console.log(data.gender, data.result_status, meta.usage.charged_credits);

<?php
require __DIR__ . '/vendor/autoload.php';

use GenderApi\Client;

$client = new Client(); // reads GENDERAPI_API_KEY
$result = $client->name('Krzysztof', country: 'PL');
echo $result->data->gender ?? 'unknown', ' ', $result->meta->usage->chargedCredits, "\n";

require "genderapi"

client = GenderAPI::Client.new # reads ENV["GENDERAPI_API_KEY"]
result = client.name("Andrea", country: "IT")
puts result.data.gender, result.usage.charged_credits

import io.genderapi.GenderApiClient;
import io.genderapi.model.GenderResponse;

GenderApiClient client = new GenderApiClient(); // reads GENDERAPI_API_KEY
GenderResponse response = client.name("Andrea", "IT");
System.out.println(response.getData().getGender());
System.out.println(response.getMeta().getUsage().getChargedCredits());

library(genderapi)

res <- genderapi_name("Katarzyna", country = "PL")  # reads GENDERAPI_API_KEY
res$data$gender
res$meta$usage$charged_credits

using GenderApi;

using var client = new GenderApiClient(); // reads GENDERAPI_API_KEY
GenderResponse res = await client.NameAsync("Alice", country: "US");
Console.WriteLine(res.Data!.Gender ?? "unknown");
Console.WriteLine(res.Meta!.Usage!.ChargedCredits);

Pozostaw integrację V1 na wersji 1.x

Pakiety w wersji 1.x pozostają dostępne dla istniejących integracji V1 i nie są przestarzałe. Przypnij wersję główną, aby aktualizacja nie zainstalowała 2.x, a następnie migruj każdą integrację, gdy będziesz gotowy.

Język	Instalacja 1.x
Python	`pip install "genderapi<2"`
JavaScript / TypeScript	`npm install genderapi@1`
PHP	`composer require "genderapi/genderapi:^1.0"`
Ruby	`gem install genderapi -v "~> 1.0"`
Java	`implementation 'com.github.GenderAPI:genderapi-java:v1.0.3'`
R	`remotes::install_version("genderapi", "1.0.3")`

Kod źródłowy i zgłoszenia

Każdy SDK jest open source. Zgłaszaj błędy lub propozycje funkcji w odpowiednim repozytorium GitHub.