railsでyahooのapiを使用する方法

Question

前提・実現したいこと

yahoo!ローカルサーチAPIを使用してwebからの入力値をキーワードとして検索し、結果の一覧を表示する機能をrailsで実装したいと考えています。APIの結果の取得の際にエラーが生じています。

発生している問題・エラーメッセージ

JSON::ParserError in RestaurantsController#list
767: unexpected token at '<?xml version="1.0" encoding="utf-8" ?> <Error> <Message> Bad Request: Authentication parameters in your request incompleted. </Message> </Error> '
    
    request = client.get(ENV['YAHOO_URI'], q)
    @api_params = JSON.parse(request.body)
  end
  
end

該当のソースコード

  def list
    q = {
      appid: ENV['YAHOO_API'],
      query: params[:name],
      format: 'json'
    }
    client = HTTPClient.new
    
    request = client.get(ENV['YAHOO_URI'], q)
    @api_params = JSON.parse(request.body)
  end

試したこと

他のAPI(RECRUIT API, OpenWetherAPI)では同様の方法で上手く機能しました。
yahooAPIに関しても以下のようにブラウザで直接検索した場合には結果を取得できました。
https://map.yahooapis.jp/search/local/V1/localSearch?appid='key'&query='keyword'&format=json

ご教示いただきますよう、よろしくお願い申し上げます。

Comments

[maisumakun]

「Authentication parameters in your request incompleted.」とありますが、APIキーなどは適切にセットしていますか？

[taig]

maisumakun様
ご返答ありがとうございます。
.envファイル内にて、
YAHOO_API = キー
YAHOO_URI = 'https://map.yahooapis.jp/search/local/V1/localSearch'
のように設定しています。
キーについては何度も確認をしているのですが、Authentication parameters in your request incompleted となってしまい、解決できていないです。

Answer 1

※誤読したので、回答を大きく変えています

  def list
    q = {
      appid: ENV['YAHOO_API'],
      query: params[:name],
+     output: 'json'
-     format: 'json'
    }
    client = HTTPClient.new

+   request = client.get(ENV['YAHOO_URI'], query: q)
-   request = client.get(ENV['YAHOO_URI'], q)
    @api_params = JSON.parse(request.body)
  end

手元の環境で試す感じだと、クエリパラメータをclient.get()に渡す際には名前付きで渡すとうまくいくようでした。
なお、APIドキュメントにもあるのですが、出力フォーマットを変えるのはformatではなくoutputのようです。

別例：

  def list
    q = {
+     'appid' => ENV['YAHOO_API'],
+     'query' => params[:name],
+     'output' => 'json'
-     appid: ENV['YAHOO_API'],
-     query: params[:name],
-     format: 'json'
    }
    client = HTTPClient.new

    request = client.get(ENV['YAHOO_URI'], q)
    @api_params = JSON.parse(request.body)
  end

Comments

[taig]

attakei様
ご回答ありがとうございます。
環境変数について、YAHOO_APIとYAHOO_URIというように異なる変数にしてあります。スペルが似ているため読みづらく、申し訳ございません。
キーについては
.envファイル内にて、
YAHOO_API = キー
YAHOO_URI = 'https://map.yahooapis.jp/search/local/V1/localSearch'
のように設定しています。

[taig]

attakei様
無事、実現したい機能を実装することができました。
ご教授いただき、ありがとうございました。