提供するWeb Api の仕様(開発者向け)
ランダム検索キーワードWeb API
このAPIは、実際に「検索窓のない検索エンジン。」で使用されているランダム検索キーワード抽出エンジンの機能を公開するものです。このAPIを呼び出すことで、任意の数のランダムなキーワードを取得することができます。
リクエストURL
http://butaman.ymk-spark.or.jp/soft/testtech/randomsearch/WebApi.aspx
リクエストパラメータ
リクエストにはRESTを使用します。
| パラメータ
|
値 |
説明 |
| results
|
integer (必須) 最大25
|
取得するランダムな検索ワードの数です。
|
|
output |
string
|
このパラメータに「json」(小文字英字)を指定すると、レスポンスはJSON形式で返されます。指定しない場合とその他の文字列を指定した場合は、XML形式で返されます。 |
|
callback |
string |
このパラメータは上記のパラメータで「json」が指定されているときに有効です。「json」が指定されている場合、callbackで指定された関数名を呼び出すjavascriptが生成され、その関数のパラメータとして本来のJSON形式のレスポンスが設定されます。
(例:「callback=test」 の場合、「test(~)」と返される)
※~は本来のJSON形式のレスポンス |
サンプルリクエストURL
http://butaman.ymk-spark.or.jp/soft/testtech/randomsearch/WebApi.aspx?results=2
レスポンスフィールド
レスポンスはXML形式かJSON形式で返されます。これはリクエストのoutputパラメータによって設定できます。
| フィールド
|
説明
|
| ResultSet
|
リクエストに対するレスポンスのすべてが格納されます。属性「totalResultsReturned」には実際に返された検索キーワードの数が設定されます。
|
|
Result |
ResultSetの子要素です。個別の検索キーワードが格納されます。 |
サンプルレスポンス
サンプルレスポンス
エラー
正しくないリクエストの場合にHTTPエラーコード400とともに以下のフィールドでエラーが返されます。XMLかJSON形式です。その他のエラーコードの場合、この書式にはならないのでご注意ください。
| フィールド
|
説明
|
|
Error |
すべての親要素です。 |
|
Title |
Errorの子要素です。エラーのタイトルが表示されます。通常は「The following errors were detected:」という文字列が格納されます。 |
|
Message |
Errorの子要素です。
エラーメッセージが格納されます。 |
制限事項
このシステムは実験的なものため特にシステム的には制限をしていませんが、1分間に10回を越えるリクエストを行わないようよろしくお願いします。詳しくは利用規約をご覧ください。