目次
エンドポイント変更点
Cinderella API v2/v1のエンドポイントを変更しました。
Cinderella API v2 の場合
| 旧仕様 | https://pink-check.school/api/v2/* |
| 新仕様 | https://api.pink-check.school/v2/* |
Cinderella API v1 の場合
| 旧仕様 | https://pink-check.school/api/v1/* |
| 新仕様 | https://api.pink-check.school/v1/* |
現在、Cinderella API を利用されている方は、エンドポイントの変更をお願いいたします。
開発者向けQ&A
Q. 旧仕様のエンドポイントは直ちに使えなくなりますか？
いいえ。旧仕様は引き続き利用可能です。
Q. 現在旧仕様のエンドポイントを現在利用している場合、変更の必要はありますか？
はい。出来る限り早期に、新仕様に変更することを推奨します。
旧仕様のエンドポイントを利用している場合は、2022/5/10以降、お問い合わせをいただいてもサポートを行えない場合があります。
Q. 旧仕様のエンドポイントを利用し続けるデメリットはありますか？
はい。旧仕様のエンドポイントを利用している場合、HTTPステータスコード 429 Too Many Requests が返りやすくなります。（2022年6月～の予定）
Q. なぜ 429 が返りやすくなるのですか？
現在、一部のユーザによる Web ポータルおよび Cinderella API への過剰なアクセスが行われており、Web サーバの一時的なダウンや、停止に至らない場合でも処理遅延を誘発しています。(※1)
負荷軽減対策として Web ポータルと Cinderella API で共有しているリソースの一部を分離することにしました。そのうえで、エンドポイント種別と Source IP-Address を複合的に考慮した利用制限をかけることで、Web サーバ全体を保護する措置を導入します。なおこの保護措置は、新仕様のエンドポイントを利用する限り、99.5% 以上のユーザは影響を受けません。
この過程で、技術的都合により、旧仕様のエンドポイントの利用については Source IP-Address を考慮しない一律の利用制限を行う予定です。これは「旧仕様で誰かが負荷をかけまくると、すべての旧仕様 API 利用者に利用制限がかかる」ことを意味します。
Q. 旧仕様から新仕様へのリダイレクトは行われますか？
いいえ。2022年5月10日時点では、301 Moved Permanently 等でのリダイレクトは計画していません。過去にドメイン変更を同様の手段で行った際に、一部の利用ユーザに影響があったため、API についてはなるべく現用のエンドポイントを維持する方針です。
ただし、これは将来にわたって HTTP によるリダイレクトを行わないことを意味するものではありません。
Q. 新仕様で使えないAPIがあるのですが？
お手数ですが、Twitter: @imcgborder2 までリプライください。早急に対応します。
※1：現在のボーダーbotは、 Web サーバ系統とイベントポイントの観測系統は主要部位が完全に分離されており、仮に Web ポータルへの集中的なアクセスがあったとしても観測に影響が出ないようになっています。