できたてサーバー（猫）リクエスト

DekitateBankのAPI（所持金確認）を提供してほしい¶

理由¶

現在、プレイヤーの所持金を確認するには、Minecraftサーバーにログインした状態で "/atm balance [MCIDまたはUUID]" コマンドを実行する必要があります。

この所持金情報を外部プログラムから安全に取得できるよう、公式の読み取り専用APIの導入を検討していただきたいです。

主な用途として、Discord Botと連携した株市場システムの構築を想定しています。APIを通じて取得した所持金情報を利用し、取引記録や市場情報の管理、Discordとのデータ同期を自動化することが目的です。

1. デメリットへの対策案

導入に伴うリスクを軽減するため、以下のような仕様を提案します。

・読み取り専用にする： 所持金の取得のみを許可し、APIから残高の変更や送金を行えないようにする。
・認証とアクセス制限を設ける： APIキーなどによる認証を導入し、利用を許可されたプログラムだけがアクセスできるようにする。
・取得対象を制限する： 任意のプレイヤーの残高を無制限に照会できないよう、取得可能な対象や権限を設定する。
・レート制限を設ける： 短時間に大量のリクエストが発生しないようにする。
・ログを記録する： APIの利用者、取得日時、リクエスト回数などを記録し、不正利用の調査に利用できるようにする。
・必要最小限の情報だけを返す：MCIDまたはUUID、所持金、取得日時など、用途に必要な項目だけを返す。

1. 希望するAPIの仕様
   例えば、認証済みのリクエストに対して、次のような情報をJSON形式で取得できる仕組みを希望します。

```json {
"uuid": "プレイヤーのUUID",
"mcid": "プレイヤーのMCID",
"balance": 123456,
"currency": "猫円",
"queried_at": "取得日時"
}
```
※上記は仕様の例であり、実際のAPIの設計やレスポンス形式は運営側の方針に合わせます。

本要望は、ゲーム内の経済情報を無制限に公開することを目的とするものではありません。
既存の所持金確認機能を、認証・アクセス制限・利用回数制限などを備えた安全なAPIとして利用できるようにすることを希望しています。

運営上の負担やセキュリティ上の懸念がある場合は、公開APIではなく、利用者を限定したAPIや、特定の用途に限定した連携方式も検討できればと考えています。

ご検討のほど、よろしくお願いいたします。

メリット¶

- データ取得の自動化
- Minecraftへのログインやコマンド入力を介さず、許可された外部プログラムから所持金情報を取得できる。
- 手動確認の手間を削減し、情報取得を効率化できる。

- Discordとの連携強化
- Discord Botと連携することで、所持金情報を利用したカブ市場の運営や取引記録の管理を自動化できる。
- 市場のレート推移や取引履歴などをDiscord上で管理しやすくなる。

- 同期ずれ・取得ミスの軽減
- ゲーム内コマンドの実行結果をチャットメッセージから解析する方式と比較して、構造化されたデータを直接取得できれば、解析ミスや応答形式の変更による不具合を減らせる。
- 取得日時や処理結果を記録することで、データの不整合を調査しやすくなる。

- 拡張性の向上
- APIを利用して、経済情報を扱う外部ツールやコミュニティ向けサービスを開発しやすくなる。
- 将来的に、ほかの統計・管理システムとの連携にも応用できる。

- 情報取得の標準化
- 所持金情報の取得方法をAPIとして統一することで、外部開発者が独自のコマンド解析処理を実装する必要性を減らせる。

デメリット¶

- セキュリティ・プライバシー上のリスク
- 所持金情報が外部から取得可能になるため、認証やアクセス制限が不十分な場合、不正な照会や意図しない情報公開につながる可能性がある。
- プレイヤーの経済状況に関する情報をどこまで公開するか、運営側で方針を決める必要がある。

- サーバーへの負荷
  - 大量のAPIリクエストが発生した場合、データベースやサーバーの処理負荷が増加する可能性がある。
  - 利用回数制限やキャッシュなどの対策が必要になる。

- 開発・保守コスト
- APIの開発、認証機能の実装、障害対応、仕様変更への対応など、運営側に追加の作業が発生する。 * 継続して安全に運用するための保守体制が必要になる。

- 障害発生時の影響
- APIの停止や通信障害が発生すると、APIを利用する外部ツールが所持金情報を取得できなくなる可能性がある。
- エラー処理や復旧手順を用意する必要がある。

- 不正利用への対策が必要
- APIキーの漏えいや第三者による大量照会を防ぐため、認証、アクセス制御、レート制限、利用ログの管理などが必要になる。

- 取得できる情報・用途の制限
- 公開範囲や利用規約によっては、任意のプレイヤーの所持金を取得できない仕様になる可能性がある。
- 他プレイヤーの情報を利用する場合、取得対象や利用目的について運営側の許可が必要になる場合がある。