使用量の監視

使用量と残りクレジットを監視

クレジット不足でワークフローが停止する前に、GenderAPIの現在残高とパッケージ有効期限を確認します。

GEThttps://api.genderapi.io/api/remaining

クォータの概要

処理開始前に利用可能なクレジットを確認

残りクレジットAPIは、監視ジョブ、社内ダッシュボード、バッチ処理から呼び出せます。性別判定を実行せず、簡潔な結果を返します。

残りクレジット9,443利用可能なリクエスト数
パッケージ状態 有効レスポンス例に基づく
有効期限1752651601UNIX timestamp
GET

残りクレジット接口

クォータ情報を確認

APIキーを key クエリパラメータへ指定します。認証情報を訪問者へ公開しないよう、サーバー側からリクエストしてください。

https://api.genderapi.io/api/remaining?key=YOUR_API_KEY
cURL
curl "https://api.genderapi.io/api/remaining?key=YOUR_API_KEY"
認証情報の保護: 公開されたブラウザーJavaScriptからこのAPIを直接呼び出さず、バックエンド、定期ジョブ、保護されたサーバー関数から利用してください。

レスポンス例

残高と有効期限

JSON
{
  "status": true,
  "remaining": 9443,
  "expiresAt": 1752651601
}

レスポンスフィールド

フィールド型説明
statusbooleanリクエストが成功し、APIキーが有効な場合は true。
remaininginteger現在利用できるAPIクレジット数。
expiresAtintegerパッケージ有効期限を秒単位のUNIXタイムスタンプで示します。

運用のヒント

先回りできるクォータ監視を構築

01

現在の利用可能クレジットを表示

社内ダッシュボードへ残高を表示し、運用・サポートチームが確認できるようにします。

02

警告しきい値を設定

残高がゼロになる前に通知し、クレジット補充の時間を確保します。

03

バッチ処理を保護

処理開始前に利用可能なクレジットと予定バッチサイズを比較します。

警告ポリシーの例

一律の値ではなく、実際のトラフィックに合わせてしきい値を設定してください。

  1. 正常残り20%超
  2. 警告残り10%~20%
  3. 重大残り10%未満

クレジット不足を事前に想定

APIエラーが出てから残高不足に気付くのではなく、適切な頻度で監視してください。各単一リクエスト前の確認は避け、アプリが処理を停止または再試行する方法を明確にします。

次のリファレンス

APIエラーを処理

エラーコード予測可能なエラー処理を構築 →料金クレジットプランを比較 →