はてなスター画像APIは、主にモバイル端末向けに、はてなスターの表示を簡易的に行なうための
API です。 <img>
要素の
src
属性に指定する形を想定し、画像形式のレスポンスを返します。
API へのリクエストサンプルを示します。
http://s.st-hatena.com/entry.count.image?uri=http://s.hatena.ne.jp/
s.st-hatena.com
の
/entry.count.image
をエンドポイントとし、パラメータとして
uri
を必ずとります。
uri
bg
#FFFFFF
) #RRGGBB
形式のスターの背景色
q
1
を指定すると倍のサイズの画像になります
といった画像のレスポンスが返ります。
画像のフォーマットは PNG, GIF, JPEG から、リクエストの User-Agent により自動的に決定されます。
現状では PNG をサポートしていない User-Agent の場合のみ (DoCoMo ケータイの一部)、JPEG 形式の内容が返却されますが、将来的に画像フォーマットは変更される可能性があります。
返却される画像のサイズはついているスターの数に応じて変化します。ただし以下に定める最大の幅よりも大きくなることはありません。
最大幅 320px, 高さ 10px
q=1
)最大幅 640px, 高さ 21px
画像 API のレスポンスに、その画像で表示されているスターの数を
X-Hatena-Star-Count
として返却しています。
これは以下のように、色名 (yellow
,
green
, red
, blue
,
purple
) とその数を
=
で連結したものを、カンマ (,
)
区切りで連結したものです。まだついていない色に関しては返されません。
X-Hatena-Star-Count: yellow=326, green=4, red=2