GenderAPI API認証｜APIキーとBearerトークン

認証の概要

APIキーの送信方法を選ぶ

認証が必要なすべてのリクエストには、有効なGenderAPIキーが必要です。認証情報をリクエストデータから分離できるため、通常はAuthorizationヘッダーを推奨します。

Bearerトークン

Authorizationヘッダーでキーを送信します。

JSONボディ

サーバー側のPOSTフィールドとしてキーを送信します。

推奨

Authorizationヘッダー

Bearerトークン

Authorization: Bearer YOUR_API_KEYを設定し、JSONボディには判定対象の入力パラメータだけを送信します。

AuthorizationBearer YOUR_API_KEY

cURL

curl -X POST "https://api.genderapi.io/api" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{"name":"Alice"}'

JavaScript

fetch("https://api.genderapi.io/api", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_API_KEY"
  },
  body: JSON.stringify({ name: "Alice" })
});

別の方法

JSONボディでAPIキーを送信

POSTボディ

APIキーを key プロパティとしてリクエストデータと一緒に送信します。信頼できるサーバー側コードからのみ使用してください。

cURL

curl -X POST "https://api.genderapi.io/api" \
  -H "Content-Type: application/json" \
  -d '{"name":"Alice","key":"YOUR_API_KEY"}'

Python

import requests

response = requests.post(
  "https://api.genderapi.io/api",
  json={
    "name": "Alice",
    "key": "YOUR_API_KEY"
  }
)
print(response.json())

認証情報の安全性

APIキーを保護する

APIキーはサーバー側の環境変数またはシークレット管理サービスに保存します。
APIキーをバージョン管理へコミットしたり、ブラウザーのJavaScriptに公開したりしないでください。
アプリケーション、プロキシ、分析ツールのログから認証情報を除外します。
すべてのリクエストでHTTPSを使用し、漏えいの可能性がある場合は直ちにキーを再発行してください。

クイック比較

どの認証方法を使うべきですか？

方法	適した用途	認証情報の場所
Bearerトークン推奨	一般的なサーバー連携	`Authorization` ヘッダー
JSONボディ	既存のPOST連携	`key` プロパティ

POSTのContent-Type：JSONボディを送信する場合は Content-Type: application/jsonを設定してください。

次のガイド

名前の単一リクエストを送信する

名前から性別を判定単一リクエストのパラメータとレスポンスを見る →クライアントライブラリ公式SDK一覧に戻る →