IP APIでのIPv4とIPv6の扱い

IP APIでIPv4とIPv6をどう扱うかは、クライアントとAPIの間の契約によって決まります。クライアントは、成功、バリデーションエラー、認証の失敗、レート制限、一時的なサーバーエラーを区別して扱う必要があります。JSONかXMLかでHTTPのセマンティクスが変わることはありません。また、IPv4/IPv6の値は、IPv4の長さを前提にせず、そのまま保持しなければなりません。

応答の扱い方

Content-Type、ステータスコード、ドキュメントに記載されたフィールド、クォータを検証します。HTTP 429は別に扱い、Retry-Afterが返された場合はそれに従い、上限付きの指数バックオフにジッターを組み合わせてください。リトライの前には冪等性も考慮します。リクエストID、ステータス、レイテンシはログに残しますが、APIのシークレットは決して記録しないでください。

IPv6アドレスの保存と検証

IP APIのフィールドを、ドット区切りのIPv4しか想定していないサイズのスキーマに保存しないでください。IPv6は正規化されたテキスト形式か適切なバイナリ表現で保持し、入力では省略形も受け付けたうえで、ループバック、IPv4射影アドレス、デュアルスタックのケースをAPIの仕様に沿ってテストしましょう。2IPのAPIの仕様は2IPのAPIのページにまとめています。