API 結果のキャッシュ¶

このページでは、API 結果(API がレスポンスとして返す JSON データや、そこから得られるアバター画像)をキャッシュして利用する際の指針を説明します。以下の課題を解決するために、キャッシュの実装は重要になります。

API接続に伴うレイテンシ低下の回避
APIの割り当てを超過した利用の回避

Info

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

Info

Webhook を利用すれば、アバターの更新通知を受け取ってアバター画像を更新することもできます。Webhook の利用も検討してください。

レスポンス(JSON)のキャッシュ¶

以下の API は、API がレスポンスとして返す JSON データを最大10分間キャッシュできます。

Info

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

レスポンス(JSON)の全てをキャッシュすることも、レスポンスの一部(アバター画像URLなど)のみをキャッシュすることもできます。キャッシュ期間を長くすると、着せ替えたアバターがなかなか自社アプリに反映されず、エンドユーザのUXを損なう可能性があるため、自社アプリにとって適切なキャッシュ期間を設定してください。

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

アバター画像URLから取得するアバター画像ファイル自体をキャッシュすることもできます。主なユースケースは、アクティブでないユーザ(自社アプリの利用を停止している休眠ユーザ)のアバター画像を、API のアクセスなしに利用したいケースです。

アバター画像ファイルのキャッシュでは、アバター画像ファイルそのものを自社のストレージに保存してキャッシュします。レスポンス(JSON)のキャッシュと異なり、キャッシュ期間に制約はありません。

最終更新日: 2022-01-21