連携をV1からV2へ移行する
V1は引き続き利用できます。準備ができたら、同じキーとクレジット残高のまま連携を1つずつ移行してください。V2はリクエストとレスポンスの仕様が異なるため、URLを変更するだけでは不十分です。
| GenderAPI.io V1 | GenderAPI.io V2 |
|---|---|
| /api, /api/email, /api/username | POST /api/v2/gender。typeにname、email、usernameのいずれかを指定し、valueを送信します。 |
| /api/name/multi/country, /api/email/multi/country, /api/username/multi/country | itemsを指定したPOST /api/v2/gender/batch。異なる種類の入力を混在させることもできます。 |
| numberとaddressを指定する/api/phone | numberとcountryを指定するPOST /api/v2/phone/validate。data.validとdata.possibleを確認します。 |
| askToAI | options.ai_mode: fallback。単一リクエストはすでにデフォルトでfallbackです |
| forceToGenderize | 3種類すべてで同じ任意フィールド。まずデータセット、次にニックネームを解釈するAI |
| フラットなレスポンスフィールド | 結果はdata、アクセスと課金の情報はmeta |
| probabilityのパーセント値 | 0–1の尺度のconfidenceとconfidence_kind。AIのスコアは較正済みの確率ではありません |
| total_names | data.sample_count（nullの場合あり） |
| used_credits / remaining_credits | meta.usage.charged_credits / remaining_credits |
| 旧形式のエラー | HTTPステータスと、Problem Detailsのcodeおよびaction |
| POSTの再試行 | 再試行はそれぞれ新しい処理で、通常どおり課金されます |
クライアントを更新して検証する
移行する連携には、V2のリクエストとレスポンスの仕様を使用してください。meta.access.modeを確認し、JSONのnullの結果を保持し、バッチでは項目ごとのエラーを確認し、再試行する前に課金を確認します。クライアントの更新が完了するまで、V1の連携は既存のパスのまま使用してください。