Nintendo ファン！
ようこそ ゲストさん
今日は 2008年08月20日(水)です

新規登録
ログインする

サイトヘルプ
Google Ads
 トップページNews Article総合掲示板ユーザーレビューハードウェア
トップページ > サイトヘルプ > Nintendoファン！API について

Nintendoファン！API について

この項目は動的なWebサイト（またはクライアントアプリケーション等）の開発者様向けとなっていますが、ページの内容に関して理解できる方なら閲覧に支障はないと思われます。
Nintendoファン！API（以下nfAPI）は、HTTPとXMLを根幹とするRESTアーキテクチャによって構成された「サイト独自のデータリソース取得インターフェース」です。狭義のAPIとは異なりますが、便宜上そのように呼んでいます。
nfAPIを使用すると、外部のサイト（CGIなど）からHTTPを使用してURLを指定するだけで簡単に「Nintendo ファン！」サイト（以下本サイト）内のニュース・レビュー・掲示板などの最新の文章データベースなどをXML形式で取得することができます。

nfAPIは主に、本サイト以外のサイト様が本サイト内のニュース・レビュー・掲示板などの文章データベースを取得するなどの目的で利用することが出来ると思います。
ただし個人情報保護の観点から、nfAPIを使用して本サイト内のユーザーデータ（各ユーザーのプロフィールやマイページなど）へアクセスすることはできません。また、本サイトがそれらのデータにアクセスできるような手段を提供することは今後も含めて一切ありません。

インターフェース仕様など


外部サイトやクライアントアプリケーションなどからHTTPを利用してデータベース取得URLを指定すると、nfAPIシステムは指定されたモードやパラメータからXMLファイルを生成しそれを送り返す、という単純な仕様になっています。

トラックバックシステムに似ていますが、トラックバックシステムでは相手のURLの他に自分のブログデータなどを送信してXMLメッセージを受ける仕組みになっているのに対し、nfAPIでは取得したいデータのURL（必要であればパラメータも付加する）を指定するとそれに応じて自動生成されたXMLファイルを受け取る仕組みになっています。
簡単に言い換えると「取得したいXMLファイルをサーバにHTTPで要求し、要求を受けたサーバがそのXMLファイルを送り返す」というような感じです。

その証拠として、ブラウザのアドレスバーに取得したいデータのURLを入力するとサーバから送り返されたXMLファイルを表示することが出来ると思います。

現在のところ送り返されるXMLファイルの文字コードはShift_JIS形式またはUTF-8形式のみとなっています。

nfAPIに関するドキュメント等

nfAPIに関する説明などを載せています。分からなくなった場合等にご利用ください。

※ 現在は詳細なドキュメント等を作成していません。送り返されるXMLファイルを各自で解析してご使用ください。

・>> URLの指定方法

基本となるURLは次の通りですが、取得するデータによって若干パラメータが異なります。

基本URL：http://www.nintendo-fan.com/nfapi/

まず、基本URLの末尾に「取得するデータタイプを指定する文字列」を追加します。
現在取得できるデータタイプは次の通りです。

◆ News Article 内の記事データ：article/
◆ ユーザーレビュー 内のレビューデータ：review/
◆ 総合掲示板 内のトピックデータ：bbs/

※ データタイプにはオプション設定を付加することができます。指定しなかった場合はデフォルトと書かれているオプションになります。
　　"datatype:option_1,option_2,..."のように指定してください。

・sjis：文字コード「Shift_JIS」で取得する（デフォルト）
・utf8：文字コード「UTF-8」で取得する

その末尾に「取得するデータID」を追加します。各アドレスのxxxxxにあたる数値です。

◆ 記事データID：http://www.nintendo-fan.com/article/index/xxxxx.html
（またはhttp://www.nintendo-fan.com/article/?id=xxxxx）
◆ レビューデータID：http://www.nintendo-fan.com/review/?revid=xxxxx
◆ トピックデータID：http://www.nintendo-fan.com/bbs/?bbsid=xxxxx

※ データIDにはオプション設定を付加することができます。指定しなかった場合はそれぞれ「最新10件のみ」取得します。
　　"dataID:option_1,option_2,..."のように指定してください。
　　以下の「コメント」はそれぞれ「記事ならそれに対するコメント」、「レビューならそれに対するレビュー」、「掲示板ならトピックに対するレス」に相当します。また、「トラックバック」は記事データのみとなっています。

・cmt-no：コメントを取得しない
・cmt-all：コメントを全て取得する
・cmt-数値：コメントを最新「数値」件のみ取得する
・tb-no：トラックバックを取得しない
・tb-all：トラックバックを全て取得する
・tb-数値：トラックバックを最新「数値」件のみ取得する

以上がURLの指定方法です。
このアドレスを指定してサーバーに送信すると、要求したデータがXML形式で返ってくることになります。

nfAPIの使用に関して注意事項

今まではβ版サービスということで記述を省いていましたが、今回リリース版に変更となったため、nfAPIの使用に関して皆様にいくつか注意していただく事項があります。

・nfAPIサービス自体は現在のところ無料（フリー）のサービスとなっていて、APIの仕様を理解できる方ならどなたでも使用することができます。
・nfAPIによって取得できるデータベース内の文章等の著作権は、それぞれの文章を本サイト内で書き込んだ方々に存在することになります。そのため、各文章の著作者名を偽るような行為等を決して行わないようにしてください。
・nfAPIを使用して取得したデータを他サイト様やアプリケーションなどで利用する場合は、必ずnfAPIを使用したという旨の記述と、本サイトへのリンク等を加えるようにしてください。nfAPIから取得したXMLファイル内にAPI名やリンク等が含まれているので、それを利用していただいてもかまいません。それができない場合はあらかじめ運営宛に問い合わせメールを送るようにしてください。

本サービスを利用される場合は、以下のような表記を追加していただければこちらとしても嬉しいかなと思っています。

※ サンプル：

・Powered by nfAPI
・Powered by Nintendo ファン！

※ 「Wii」は任天堂の登録商標です。また、このサイトは任天堂とは一切関係ありません。
Copyright : （C)2006-2008 Nintendo ファン！　　　All Rights Reserved.