URLの示すページからOGP(Open Graph Protocol)での情報取得を行うフリーAPIです。
140noteで使用する目的で作られたものですが、本APIそのものはTwitterとまったく関係ありません。
上のチェック用フォームでURLとユーザーエージェントを指定すると結果を表示できますので、開発者以外の方も、サイトからどのような情報が取得されているかの確認にご活用ください。
OGPとはHTML上に書かれたそのページを示す情報のフォーマットですが、詳しくはここでは説明しないのでこのページでも読んでみてください。
http://api.hitonobetsu.com/ogp/analysis?url=対象URL
文字コードはUTF-8、戻りはjson形式です(希望が多ければxmlもサポートするかもしれません)。
指定できる前パラメータは以下の通りです(必須なのはurlのみ)。
| url | 対象ページのURL (代表的な短縮URLであれば自動展開) |
|---|---|
| callback | jsonp形式とする際に指定してください |
| ua |
対象URLにアクセスするユーザーエージェントの指定です。サイトによってユーザーエージェント毎の振る舞いが異なるため、指定しても期待通りの結果が返ってこないケースもあります。
未指定:
APIを呼び出す環境によって自動で切り替わります。 pc: PC iphone: iPhone ipad: iPad
android:
Android
wp:
Windows Phone |
以下の4つの値については、OGPに設定されていなくとも可能であれば代替の値を返します。
http://api.hitonobetsu.com/ogp/analysis?url=http%3A%2F%2Fwww.yahoo.co.jp%2F
{
"title":"Yahoo! JAPAN"
"type":"article",
"url":"http://www.yahoo.co.jp/",
"image":"http://k.yimg.jp/images/top/ogp/fb_y_1500px.png",
"description":"日本最大級のポータルサイト。検索、オークション、ニュース、天気、スポーツ、メール、ショッピングなど多数のサービスを展開。あなたの生活をより豊かにする「課題解決エンジン」を目指していきます。",
"site_name":"Yahoo! JAPAN"
}
http://api.hitonobetsu.com/ogp/analysis?url=http%3A%2F%2Fwww.yahoo.co.jp%2F&callback=callback&ua=iphone
callback(
{
"title":"Yahoo! JAPAN"
"url":"http://m.yahoo.co.jp/",
"description":"日本最大級のポータルサイト。検索、オークション、ニュース、天気、スポーツ、メール、ショッピングなど多数のサービスを展開。あなたの生活をより豊かにする「課題解決エンジン」を目指していきます。"
}
);
サポートや動作保証はいたしません。自己責任の範囲でお使いください。
現在はアクセス制限をかけておりません。利用状況を見て、アクセス制限やサーバ増強等考えます。
公序良俗に反する、あるいは違法なサイトやサービスでの使用は禁止します。
紹介やリンクは正直とても嬉しいです(義務ではありません)。
意見、感想等の連絡は開発者のTwitterアカウントにどうぞ
| version | リリース日 | 概要 |
|---|---|---|
| 0.1.0 | 2013.9.30 | 公開 |
本APIはApache License2.0にて配布されているOpenGraph.phpを使用しています。