認証とIPトライアル サーバーからAuthorization: Bearer YOUR_API_KEY を送信し、YOUR_API_KEY を既存のGenderAPI.io のキーに置き換えてください。両バージョンは残高を共有するため、V2用の別契約や別のキーは不要です。
すべてのPOSTリクエストにはContent-Type : application/jsonが必要です。既存のAPI キーをBearer認証で送信してください。各リクエストは個別に処理され、同じリクエストを再送した場合も通常どおり課金されます。
keyクエリパラメーターも受け付けるのはGET /gender だけです。URLはブラウザの履歴やログに残る可能性があるため、連携にはAuthorizationヘッダーを推奨します。秘密のキーをフロントエンドのコードに含めないでください。
キーがない場合、形式が正しくない場合、または認識されない場合は、V1と共有のIPトライアルに切り替わります。認識されたキーが無効化、期限切れ、または制限されている場合は切り替わりません。meta.access.mode の値(api_key 、ip_trial 、unauthenticated)を確認してください。切り替えの理由はapi_key_missing 、api_key_invalid 、api_key_not_found のいずれかです。そのため、無効なキーでもIPトライアルとして成功のレスポンスが返ることがあります。本番環境ではアクセスモードを必ず確認してください。
IPトライアルのクレジットは24時間の期間が終わるとリセットされます。午前0時とは限りません。/usageでresets_at を確認してください。同じパブリックIPを使うユーザーはこのクレジットを共有します。
APIキーを設定する GenderAPI.io アカウントからAPI キーをコピーし、下のYOUR_API_KEY をそのキーに置き換えてから、同じターミナルセッションで選んだ例を実行してください。これらのコマンドは、そのセッションだけで有効な環境変数を設定します。ページに記載されたプレースホルダーは実際に使えるキーではありません。
アプリケーションやデプロイ環境では、GENDERAPI_API_KEY をサーバー側のシークレットとして設定してください。例では.envファイルは自動的に読み込まれません。キーをブラウザ向けのバンドル、ソース管理、公開URLに含めないでください。
export GENDERAPI_API_KEY = 'YOUR_API_KEY' $ env: GENDERAPI_API_KEY = 'YOUR_API_KEY' クレジットを消費せずにアクセスを確認する BearerヘッダーでGET /usage を呼び出します。有効なアカウントのキーであれば、meta.access.mode : api_key が返ります。結果がip_trial の場合は、推定を実行する前にコピーしたキーを確認してください。このリクエストは無料で、クレジットが残っていないアカウントでも呼び出せます。
プログラミング言語を選んでください。 APIキーを設定する 。次に、サーバー上で例を実行してください。
この残高照会はクレジットを消費しません。ただし、リクエストのレート制限にはカウントされます。
実行する前に:アクセスとエラー処理 これらの例はサーバー上で実行してください。プロセスの環境変数GENDERAPI_API_KEY に既存のAPI キーを設定し、meta.access.mode がapi_key であることを確認します。認識されないキーはIPトライアルに切り替わることがあります。
HTTP 4xxと5xxのJSON レスポンスでは、例はエラーのボディをそのまま残し、0以外の終了ステータスで終了します。再試行する前にcode 、action 、meta.usage.billing_status を確認してください。
エラーと再試行のガイド → cURL JavaScript Python PHP Java C# / .NET Go
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 }" POSIXシェルでcURL 7.76以上。 ターミナルで実行します。実行環境のドキュメント
// 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を実行します。実行環境のドキュメント
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
$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を実行します。実行環境のドキュメント
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を実行します。実行環境のドキュメント
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を実行します。実行環境のドキュメント
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を実行します。実行環境のドキュメント