コンテンツにスキップ

API 結果のキャッシュ

このページでは、APIのレスポンスやアバター画像をキャッシュして利用する際の指針を説明します。以下の課題を解決するために、キャッシュの実装は重要になります。

課題 解決策
API接続に伴うレイテンシ低下の回避 API レスポンスのキャッシュ
APIの割り当てを超過した利用の回避 API レスポンスのキャッシュ
アクティブでないユーザがMAUに含まれてしまうことの回避 画像ファイルのキャッシュ

Info

キャッシュのためのキャッシュサーバやファイルストレージは自社サーバ側に準備する必要があります。

API レスポンスのキャッシュ

API のレスポンス(JSON)をキャッシュして一定期間再利用します。API は常に最新のデータを返しますが、自社アプリににおいて更新遅延を許容できるケースでは、キャッシュを利用できます。

以下の API は、API のレスポンスを最大10分間自社サーバ側にキャッシュして利用できます。

Warning

Items API は、パラメータに avatarId を指定した場合の結果はキャッシュできません。

Warning

アバターやアイテムの画像およびそのURLは、自社アプリ以外の経路で変更される可能性があるため、10分を超えてキャッシュを利用することは避けてください。

キャッシュする範囲

レスポンス(JSON)の全てをキャッシュすることも、一部(URLのみなど)をキャッシュすることもできます。どちらの場合も、キャッシュ期間は最大10分です。

アバター画像ファイルのキャッシュ

アクティブでないユーザ(自社アプリの利用を停止しているユーザ)のアバター画像を、API のアクセスなしに利用したいケースがあります。この場合、アバター画像ファイルそのものを自社のストレージにキャッシュして利用できます。

アバター画像ファイル自体をキャッシュする場合は、Webhook を利用するようにしてください。


最終更新日: 2020-10-20


最終更新日: 2020-10-20