Buckler APIメモ

ドキュメントの内容

• はじめにルートの仕組み、必要なもの、安全側に運用する方法。
• 認証セッションCookie、必要なヘッダー、更新時の動作。
• エンドポイント一覧観測済みのプロフィール、バトルログ、検索、順位ルート。
• 観測済みスキーマ観測ごとの信頼度ラベル付きフィールド解説。
• エラーとバージョン管理HTTPと埋め込みステータスコード、古いbuild ID、空のレスポンス。
• 倫理的な利用レート制限、アクセス制御、避けるべき行為。

構築前にお読みください

REST APIではありません

Bucklerは自社フロントエンド用のNext.js page-dataルートを公開しています。ルート、フィールド、認証動作は予告なく変わることがあります。ドキュメントには信頼度ラベルがあり、再現済みの内容と一度だけ観測した内容を区別できます。

認証情報は提供しません

このリポジトリは、セッション回避、非公開ゲームサービスの認証、リプレイのダウンロード、保存済みユーザーレスポンスを提供しません。自分でログインしたブラウザのセッションを、適切な頻度で使用してください。

変更に備える

HTTPステータスと埋め込みステータスコードの両方を検証してください。Capcomのデプロイ後は、現在のNext.js build IDを再取得する必要があります。すべてのフィールドをnullableとして扱ってください。

観測結果を共有する

公開フロントエンドの通常利用で新しい動作を観測した場合は、GitHubのIssueやPull Requestを歓迎します。証拠とサニタイズの要件はCONTRIBUTING.mdに記載されています。