API: 2008年4月アーカイブ

SemantiqNodeとの通信にはhttpを使用します。APIを使用するときはCGIを呼び出すのと同様の方法を用い、パラメータをクエリーに指定し、特定のCGIを呼び出します。APIの実行結果はhttpレスポンスのbody部分で受け取ります。その際の文字コードはUTF-8を利用します。

※説明では簡単に記載するために、GET形式を使っておりますが、実際にはPOST形式を使ってクエリーを送信します。

クエリーには必須パラメータとしてactionキーがあり、実行するアクションを指定します。さらにアクションに必要なパラメータについてもクエリーで指定します。

• 認証
• SemantiqNodeをインストールしたPCに対して認証を行ないます。
• ファイル一覧
• 指定したフォルダ内のファイル一覧を取得します。
• ファイル取得
• 特定のファイルを取得します。
  
• デスクトップ検索
• Googleデスクトップと連携し、検索結果を取得します。
• メール検索
  
• OutlookExpressやThunderbird 2で受信したメールを検索します。

• MySearch用に開発し、JavaScriptからSemantiqNodeへアクセスするためのライブラリを用意しています。

ダウンロードはこちら
http://dream.jp/mysearch/javascripts/snodeapi.js

• ブログパーツ用CGI。公開ディレクトリの「photos」フォルダにある画像一覧をXML形式にて返します。

説明、ダウンロードはこちら
http://blog.dream.jp/2008/04/20080418-7.html

• ブログパーツ向けに以下のCGIをご利用ください。公開ディレクトリの「photos」フォルダにある画像一覧をXML形式にて返します。
• 
  

• 最大15のファイルをXML形式にてランダムにて返します。

• http://snapi.dream.jp/blog/snphoto.cgi?snhost=ノード名
  

http://snapi.dream.jp/blog/snphoto.cgi?snhost=dreamhubblog_node

• HTTP
  
• パラメータ必須

• ホスト：http://snapi.dream.jp/
• ノード名：アクセスしたいノード名

• action:sn.file.get
• path:アクセスするファイル名（パス含む）

http://snapi.dream.jp/sn/dreamhubblog-node/_pub/do?action=sn.file.get
&path=/_pub/photos/yama.jpg


レスポンス

• 指定のファイルのContent-Typeでバイナリ形式でファイルが返ります。ファイルが存在しない場合は、404エラーが返ります。

• HTTP
  
• パラメータ必須

• ホスト：http://sngate.dream.jp/
• ノード名：アクセスしたいノード名

• action:sn.file.getList
• path:アクセスするディレクトリ
• rformat:戻りのフォーマット
• JSON
• JSONP

http://snapi.dream.jp/sn/dreamhubblog-node/_pub/do?action=sn.file.getList
&path=/_pub/photos/&rformat=JSONP


レスポンス

• httpレスポンスのbody部にjson形式またはjsonp形式にて格納されます。

element名	説明
action	実行したaction名を返します
info	現在のページ、最大ページ数、全ファイル数を返します
items	セッションIDを表示します
	href:相対パス+ファイル名を表示します
	displaypath:相対パスを表示します
	name:Unicodeでのファイル名を表示します
prop	ContentType,作成日,ファイルサイズを表示します
mestat	messageとstatus elementを保持します
status	エラーの種類や状態を表します

{
	"response":{
		"action":"sn.file.getList",
		"info":{
			"page":"1",
			"pages":"1",
			"allitems":"1"
		},
		"items":[{
			"href":"/_pub/photos/yama.jpg",
			"displaypath":"%u002f",
			"name":"%u0079%u0061%u006d%u0061%u002e%u006a%u0070%u0067",
			"displayname":"",
			"prop":{
				"contenttype":"image/jpeg",
				"datetime":"2007-10-19 01:19:02",
				"size":"292479"
			}
		}],
		"mestat":{
			"status":"200",
			"message":""
		}
	}
}

onJSONP(
{
	"response":{
		"action":"sn.file.getList",
		"info":{
			"page":"1",
			"pages":"1",
			"allitems":"1"
		},
		"items":[{
			"href":"/_pub/photos/yama.jpg",
			"displaypath":"%u002f",
			"name":"%u0079%u0061%u006d%u0061%u002e%u006a%u0070%u0067",
			"displayname":"",
			"prop":{
				"contenttype":"image/jpeg",
				"datetime":"2007-10-19 01:19:02",
				"size":"292479"
			}
		}],
		"mestat":{
			"status":"200",
			"message":""
		}
	}
}
);

• HTTP
  
• パラメータ必須

• ホスト：http://sngate.dream.jp/
• ノード名：アクセスしたいノード名

• action:auth
• egid:メールアドレス
• password:SemantiqNodeパスワード
• rformat:戻りのフォーマット
• JSON
• JSONP

http://sngate.dream.jp/dreamhubblog-node/?action=auth
&egid=taro_dti@dream.jp&password=abcd123&rformat=JSONP

レスポンス

• httpレスポンスのbody部にjson形式またはjsonp形式にて格納されます。

element名	説明
account	メールアドレスを返します
prop	親elementに関係したプロパティを保持します
sessid	セッションIDを表示します
mestat	messageとstatus elementを保持します
status	エラーの種類や状態を表します

例：JSON形式
{
	'account':'taro_dti@dream.jp',
	'prop':{
		'sessid':'925412b370f619fcc5926c77f79571cf',
		'timeout':'300'
	},
	'mestat':{
		'status':'200'
	}
}

例：JSONP形式

onJSONPAuth(
{
	'account':'taro_dti@dream.jp',
	'prop':{
		'sessid':'925412b370f619fcc5926c77f79571cf',
		'timeout':'300'
	},
	'mestat':{
		'status':'200'
	}
}
);