SAGOOLトップ

SAGOOLについて

WEB API NEW!
   ・SAGOOL AJAX API
   ・SAGOOL API
   ・WACAAL API
   ・ガイドライン

ヘルプ

利用規約

プライバシーポリシー

人材募集

お問い合わせ

SAGOOL 検索フレーズ API ( WACAAL API )

 

WACAAL APIを利用してアプリケーションを開発

好きな開発言語から、WACAAL APIを利用して、オモロ検索エンジンSAGOOLの「今検索されているクエリ」を利用することができます。

WACAAL APIは JSON 規格に基づいて利用できます。JSON形式はシンプルなデータ転送フォーマットで、様々な言語で利用することができます。

WACAAL APIご利用の際には、次の点にご注意ください。
  1. WACAAL APIはベータバージョンです。利用状況により、サービスの仕様変更、あるいはサービスを停止する可能性があります。
  2. WACAAL APIの利用状況把握のため、クエリパラメータにSAGOOL API を利用するWEBアプリケーションのURLを指定してください。
  3. WACAAL APIを利用するアプリケーションは、見やすい位置に「SAGOOL」へのリンクとロゴを表示してください。詳細はこちらをご覧ください。
  4. WACAAL APIの利用はリクエスト元のIP毎に制限が設けられています。現状では 1IP あたり 24時間に 1万回、１秒に1回が上限となっています。
  5. WACAAL APIは１秒に1回更新されます。

利用のガイドライン

 
ガイドラインに同意いただけない場合は、WACAAL APIを使用するライセンスは許諾されません。

API利用のガイドライン

URLの構築

 
WACAAL API は、次のパスにGETリクエストを投げ、XMLを取得します。

http://sagool.jp/wacaalapi

このあとには、実際のクエリーパラメータが続きます。パラメータは「引数=値」の形式をとります。引数と値はURLエンコードします。複数パラメータは'&'で区切ります。

■パラメータ解説
パラメータ名形式説明デフォルト
typejson,xml形式を返します。xmlかjsonを指定します。json
engineweb,movieクエリを投げられたエンジンの名前を返します。web と movieが指定できます。web
hitsParPage数値いくつ結果を返すかを指定します。1～50が指定できます。30
clientUrlURL文字列SAGOOL API を利用するWEBアプリケーションのURLを指定します。UTF-8をURLエンコードしてください。必ず指定してください。WEBアプリケーション以外（ウェジット等）の場合は、配布ページのURLを指定します。WEB上に配布ページがない場合は個別に相談してください。なし
callbackコールバック関数名JSON形式で返す際にcallbackパラメータが指定されると、与えられた文字列をそのままjavascript関数として、第一引数に結果を挟みます。いわゆるJSONP形式になります。これが与えられない場合は、JSON形式です。なし

clientUrl が未指定の場合はエラーを返します。clientUrlは他のAPIにおけるAPI-KEYのようなものとお考えください。弊社でAPIの利用状況を把握し、サービス改善の指針とするために使用します。API利用者が事前に申請する必要はありません。利用状況によっては一部の形式のURLが利用できなくなる可能性があります。

以下は json 形式でWEB検索のクエリを30件得ます。

http://sagool.jp/wacaalapi?engine=web&clientUrl=http%3A%2F%2Fsagool.jp%2F

レスポンス(JSON)

 
WACAAL API は、正常なリクエストに対して次のようなJSONを返します。

[{"keyword":"ああ","link":"http://sagool.jp/s?query=%E3%81%82%E3%81%82","hits":530341},
 {"keyword":"あ","link":"http://sagool.jp/s?query=%E3%81%82","hits":1718623},
 {"keyword":"銀行","link":"http://sagool.jp/s?query=%E9%8A%80%E8%A1%8C","hits":656016}]

オブジェクトが配置された大きな配列になっています。オブジェクトの各プロパティーは次の意味を持ちます。

プロパティーデータタイプ説明
keyword文字列SAGOOLへ投げられたクエリ
hits数値SAGOOLでの検索結果数
linkURLSAGOOLで検索する場合のURL

また、callback=funcname のように、コールバック関数が指定されている場合、

funcname([{"keyword":"ああ","link":"http://sagool.jp/s?query=%E3%81%82%E3%81%82","hits":530341},
 {"keyword":"あ","link":"http://sagool.jp/s?query=%E3%81%82","hits":1718623},
 {"keyword":"銀行","link":"http://sagool.jp/s?query=%E9%8A%80%E8%A1%8C","hits":656016}])

このように関数として認識され、その関数の第一パラメータとして結果が渡されます。scriptタグの挿入などによるドメイン越えのスクリプト利用に利用できます。

レスポンス(XML)

 
WACAAL API は、正常なリクエストに対して次のようなXMLを返します。

フィールドデータタイプ説明
rss 全体を囲むタグです
   item 検索結果一件につき一つのItemタグで囲まれます
   title文字列SAGOOLへ投げられたクエリ
   description数値SAGOOLでの検索結果数
   linkURLSAGOOLで検索する場合のURL

エラーについて

 
WACAAL APIでは次の場合にHTTPヘッダでエラーを返します。

HTTPコード説明
400clientUrl が不正、あるいは制限された clientUrl の場合
403利用制限を超えた使用の場合

お問い合わせ

 

WEB APIに対する要望や質問は、SAGOOL 運営事務局にお寄せください。

SAGOOLのAPIを利用することによって、ガイドラインの内容に同意いただいたものとみなします。本ガイドラインに同意いただけない場合は、SAGOOLのAPIを使用するライセンスは許諾されません。