Officiella SDK:er för GenderAPI.io V2

Välj ett paket

De officiella SDK:erna med öppen källkod anropar samma V2-API som beskrivs i de här guiderna. Version 2.x av varje paket använder API V2. Installera 2.x-versionen i nya projekt.

Språk	Paket	Installation	Krav
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 eller .NET Standard 2.0

Om paketregistren

Java: lägg till https://jitpack.io bland dina repositorier. Samma version publiceras även på GitHub Packages som io.genderapi:genderapi, vilket kräver en GitHub-token med read:packages.
R: CRAN tillhandahåller fortfarande 1.x-paketet medan version 2.0.0 granskas av CRAN. Installera 2.0.0 från GitHub-taggen tills CRAN publicerar den.
JavaScript: paketet är avsett för körmiljöer på serversidan. Använd det inte i webbläsarkod, eftersom det skulle exponera din API-nyckel.

Gemensamt beteende

Varje klient läser API-nyckeln från GENDERAPI_API_KEY eller tar emot den i konstruktorn. Förvara nyckeln på din server.
Utan API-nyckel använder förfrågningarna den delade IP-provperioden: 10 krediter per IP-adress per 24 timmar.
Att importera ett paket eller skapa en klient skickar ingen förfrågan. Varje metodanrop skickar exakt en förfrågan.
Ingen SDK gör om en förfrågan automatiskt. Ett nytt försök är en ny åtgärd som debiteras som vanligt, så kontrollera först felet och debiteringsstatusen.
SDK:erna följer inte omdirigeringar, och standardtidsgränsen är 10 sekunder.
Ett okänt resultat är ett lyckat svar: gender är null och förfrågan debiteras som vanligt.
Felen anger HTTP-status, felkod, förfrågans ID och, om det finns, värdet i Retry-After.

Snabbstartsexempel

Varje exempel skickar en namnprediktion och kostar 1 kredit. Ange först GENDERAPI_API_KEY i servermiljön. README-filen i varje repository beskriver batchförfrågningar, kontroll av användningen och felhantering.

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('Erik', country: 'SE');
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("Elsa", country = "SE")  # 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);

Behåll en V1-integration på 1.x

Paketen i version 1.x finns kvar för befintliga V1-integrationer och är inte utfasade. Lås huvudversionen så att en uppdatering inte installerar 2.x, och migrera sedan varje integration när du är redo.

Språk	Installation av 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")`

Källkod och ärenden

Alla SDK:er har öppen källkod. Rapportera buggar eller önska funktioner i motsvarande GitHub-repository.