アクセスランキング取得 APIの使い方 || OSS iPedia

アクセスランキング取得APIの使い方

アクセスランキング取得APIは、OSS iPediaでアクセス数の多いページのトップ10を週ごとに取得する機能を提供します。

リクエスト例

http://ossipedia.ipa.go.jp/webapi/accessranking?key=XXXXXXXX&target=all&startPage=1

リクエストURL

http://ossipedia.ipa.go.jp/webapi/accessranking

リクエストパラメータ

パラメータ	説明	値	デフォルト値
key(必須)	OSS iPedia webAPIの利用キー	string
target	検索対象。"all"(全て), "article"(記事), "case"(導入事例), "report"(性能評価), "pdf"(公開資料), "kb"(Q&A・用語集・ディレクトリ)から選択する	string	all
startPage	検索結果のセットのページ番号。1が先週のアクセスランキング、2が2週前のアクセスランキング、…を示す	integer	1

レスポンス例

<rss version="2.0" 
	xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/"
	xmlns:atom="http://www.w3.org/2005/Atom">
	<channel>
		<title>OSS iPedia All Access Ranking in this week</title>
		<link>http://ossipedia.ipa.go.jp/webapi/accessranking?key=PHD452A6KV&target=all&startPage=1</link>
		<description>Access ranking of "all" at OSS iPedia in this week</description>

		<opensearch:startPage>1</opensearch:startPage>
		<opensearch:itemsPerPage>10</opensearch:itemsPerPage>
		<atom:link rel="search" type="application/opensearchdescription+xml"
			href="http://ossipedia.ipa.go.jp/webapi/opensearchdescription.xml"/>
		<opensearch:Query
			xmlns:ossipedia="http://ossipedia.ipa.go.jp/webapi/opensearchextensions/1.0/"
			role="request"
			searchTerms="linux"
			startPage="1"
			ossipedia:target="ossipedia" />
		<item>
			<title>障害解析用Linuxメッセージ・マニュアルデータベースのコンテンツ作成（報告書）</title>
			<link>http://crab412.rs-dom.mizuho-ir.co.jp/doc/3</link>
			<description>障害解析用Linuxメッセージ・マニュアルデータベースのコンテンツ作成（報告書）</description>
		</item>
			<title>電話会議システムの開発</title>
			<link>http://crab412.rs-dom.mizuho-ir.co.jp/article/2</link>
			<description>電話会議システムの開発</description>
		</item>
	</channel>
</rss>

レスポンス

フィールド	説明	親要素
rss	レスポンスの全てを含む要素	なし
channel	配信元を示す要素	rss
title	配信元の名称	channel
link	配信元のURL	channel
description	配信元の簡単な説明	channel
opensearch:startPage	検索結果のセットのページ番号	channel
opensearch:itemsPerPage	ページあたりに返される検索結果の個数	channel
opensearch:Query	検索クライアントが実行できる検索クエリの定義	channel
item	配信物を示す要素	channel
title	配信物のタイトル	item
link	配信物の存在するURL	item
description	配信物の簡単な説明	item
pubDate	配信物が公開された時刻	item

アクセスランキング取得APIの記述文書

エラーレスポンス例

<Error>
	403: Forbidden.
</Error>

エラーレスポンス

フィールド	説明	親要素
Error	エラーコード+エラーメッセージ	なし

エラーコード

コード	説明
400	Bad request. 渡されたパラメータが期待されたものと異なる場合
403	Forbidden. アクセスを許されていない場合
404	Not Found. 指定されたリソースが見つからない場合

サンプルコード

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html lang="ja">
  <head>
    <title>アクセスランキング取得API使用例</title>
  </head>
  <body>
<?php
function getContent()
{
    // URLの作成
    $request_url = "http://ossipedia.ipa.go.jp/webapi/accessranking";
    $key = "XXXXXXXX";
    $startPage = 1;
    $request_url .= "?startPage=".$startPage."&key=".$key;

    // APIへの接続
    $content = file_get_contents($request_url);
    if (!$content) {
      return "<p>情報の取得に失敗しました</p>";
    }

    // 取得XMLの解析
    $xml = simplexml_load_string($content);
    if (!$xml) {
      return "<p>情報の取得に失敗しました</p>";
    }

    // 出力の作成
    $ns = $xml->getNamespaces(true);
    $result = "<ul>\n";
    foreach ($xml->channel->item as $item) {
      $result .= "<li>";
      $result .= "<a href=\"".(string)htmlspecialchars($item->link)."\">";
      $result .= (string)htmlspecialchars($item->title);
      $result .= "</a>";
      $result .= "<p>".(string)htmlspecialchars($item->description)."</p>";
      $result .= "</li>\n";
    }
    $result .= "</ul>\n";
    return $result;
}
?>
    <h1>アクセスランキング取得API使用例</h1>
    <?php echo getContent(); ?>
  </body>
</html>

Web APIの利用申請について

Web APIを利用したい方はこちらからWeb API利用キーの利用申請をしてください。

アクセスランキング取得例

OSSライセンスの比較、利用動向および係争に関する調査
OSSライセンスの比較、利用動向および係争に関する調査
「アプリケーション実行基盤としてのOpenJDKの評価」
「アプリケーション実行基盤としてのOpenJDKの評価」
GNU GPLv3 逐条解説書
GNU GPLv3 逐条解説書
社内向けクラウド構築のために活用できるソフトウェアカタログ
社内向けクラウド構築のために活用できるソフトウェアカタログ
Q：Linuxカーネルのバージョン番号には、どのような意味がありますか？
Q：Linuxカーネルのバージョン番号には、どのような意味がありますか？
「OSS信頼性評価ツール活用セミナー」資料
「OSS信頼性評価ツール活用セミナー」資料
第4回地方自治体における情報システム基盤の現状と方向性の調査
第4回地方自治体における情報システム基盤の現状と方向性の調査
OSS信頼性評価ツールMOSST技術資料
OSS信頼性評価ツールMOSST技術資料
クラウド運用管理ツールの基本機能、性能、信頼性評価
クラウド運用管理ツールの基本機能、性能、信頼性評価
PDF帳票開発ツール Field Reports
PDF帳票開発ツール Field Reports