このAPIはkanaaa224が個人で開発したもので、ポートフォリオに載せる制作物（アプリ・ゲーム）で使用する目的で開発しました。
開発したAPIは自宅にある常に電源ONのPC（オンプレ 物理サーバー）にデプロイし、動作させています。
また、以前友人や家族とゲーム開発した際にバックエンド処理でサーバーが必要になり困ったことがあったため、誰でも使用できるように設計されています。
分離した複数のAPIが独立して動作しています。
（リバースプロキシによりルーティングされるため、ポート指定などは必要ありません。）
| API 名 | 説明 |
|---|---|
| WebAPI v1 | PHPで実装したWebAPI |
| WebAPI v2 | 新しくPythonで実装したWebAPI |
このリポジトリに含まれているendpoints.jsonを使用先でフェッチし、APIの接続先となるURIを取得しそこへ呼び出します。
（直接接続する場合、手順 1、2をスキップし、3のアドレスを使用します。）
・手順 1
GitHub上で、このリポジトリに含まれているコードからendpoints.jsonファイルを開き、「raw」ボタンを押す。
・手順 2
「raw.githubusercontent.com/xxx/endpoints.json」のようなページが開くので、ページのURLを使用先でコピペし、そのURLのコンテンツ（JSONファイル）をフェッチします。
・手順 3
フェッチしたデータからAPIの接続先となるURIを取り出します。
WebAPIを使用する場合、バージョンは現時点で「v1」が最新となります。
（現時点で「ponzu.server-on.net/api/v1/」が最新のアドレスとなるので、変更が無い場合これと同一のはずです。）
・手順 4
APIのURIへリクエストを送信し、呼び出します。
機能や詳細については「API 一覧」から確認してください。
・急な仕様変更や提供停止
急に仕様が変更されたり、提供を停止する可能性があります。
・お粗末な仕様、性能
素人が趣味レベルで開発したものなので、その点ご了承ください。
・ユーザー認証が必要なケース
一部の機能や秘匿性の高いデータを扱う場合で、認証を行う必要があります。
この場合、IDとパスワードでログインすることで利用者を確認するユーザー認証を用いて認証を行います。
また、これを行うためユーザー作成を事前に行なっておく必要があります。
・自己責任
自己責任で使用してください。
このAPIはあくまで個人で使う用途で開発したものですが、全ての機能を無償で自由に使うことができます。
ただし、リクエストする場合サーバーに与える負荷やデータベースの労力を考慮してください。
（同じデータを繰り返しリクエストしなくて済むように、応答をキャッシュするなど）
また、事前の申告なしに異常な数のリクエスト（1日に数千回など）を行うと、攻撃と見なされ当該IPによるアクセスが永久的に拒否される可能性があります。