requestsを使い、スマレジAPIで顧客データを参照したい

Question

前提・実現したいこと

PythonでスマレジAPIを操作し、
json形式のデータを取得したいと考えています。

発生している問題

proc_Nameという処理名がないため、不正パラメーターとなりエラーが発生しています。

試した事

• https://smaregi.jp/で自分のアカウントを作成し、実験しています。
• ソースで、proc_Nameを指定していますが、特にエラーメッセージに影響は見られなかったです。
• プロセス名を指定したいため、requestsのドキュメントにあるproc_name --name customer_refとオプションをつけても結果は変わりませんでした。

エラーメッセージ

#print(r.reason)
Bad Request

#print(r.content)
b'{"error_code":15,"error":"\u51e6\u7406\u540d\u304c\u7121\u52b9\u3067\u3059\u3002","error_description":"\u30d1\u30e9\u30e1\u30fc\u30bf\u4e0d\u6b63\u3067\u3059\u3002(procName is empty)"}'
#上記の翻訳
b'{"error_code":15,"error":"処理名が無効です。","error_description":"パラメータ不正です。(procName is empty)"}'

#urlエンコードする前
http://webapi.smaregi.jp/access/?proc_Name=customer_ref&fields=customerCode&fields=lastName&fields=firstName&conditions=customerId&order=customerCode+desc&limit=100&table_name=Customer
#paramsをurlエンコードした結果
#print(r.url)
http://webapi.smaregi.jp/access/?%7B%27proc_Name%27%3A%20%27customer_ref%27%2C%20%27fields%27%3A%20%5B%27customerCode%27%2C%20%27lastName%27%2C%20%27firstName%27%5D%2C%20%27conditions%27%3A%20%5B%7B%27customerId%27%3A%20%27213%27%7D%5D%2C%20%27order%27%3A%20%5B%27customerCode%20desc%27%5D%2C%20%27limit%27%3A%20100%2C%20%27table_name%27%3A%20%27Customer%27%7D

該当のソースコード

#coding: utf-8
import requests
import urllib
import json

#ベーシック認証用
user_name = "[e-mail]"
password = "xxxxxxxx"

#アクセスするURL
url = "http://webapi.smaregi.jp/access/"

#paramsを定義
params = {
  "proc_Name":"customer_ref",
  "fields":["customerCode","lastName","firstName"],
  "conditions":[{"customerId":"213"}],
  "order":["customerCode desc"],
  "limit":100,
  "table_name":"Customer"
}

#json分解不可を回避
params = urllib.parse.quote(str(params))

#headerを定義
headers = {
"X-access-token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"X-contract-id": "xxxxxxxx",
"Content-Type": "application/x-www-form-urlencoded;charset=UTF-8"
}

#リクエストをPOST
r = requests.post(url=url, params=params, headers=headers, auth=(user_name, password))

#結果を表示
print(r.reason)
print(r.content)
print(r.url)

参考文献

「スマレジ APIのご紹介」のスライド

補足情報（FW/ツールのバージョンなど）

Mac OS X
requests==2.21.0
urllib3==1.24.1

Comments

[Lhankor_Mhy]

『ソースでは、jsonでproc_Nameを指定していますが、無効になってしまいます。』とのことですが、JSONとはどれのことを指していますか？外部ファイルにあるのでしょうか？
また、『無効になってしまいます』とは具体的には何が起きていますか？

[yep.app]

すみません。説明不足でした。`#paramsで指定`の部分で「json形式で記述」という事が言いたかった事でした。

paramsを定義の部分で`"proc_Name":"customer_ref",`と書いています。
しかし、この部分が動くのかは分からずに書いてしまっています、、、。

この箇所を加えたことによる変化を期待しましたが、特にエラーメッセージは変わりませんでした。

Answer 1

自分の学習のためにサンプルコードを残しておきます。
以下https://web.postman.co/ にて行いました。
パラメータの送り方が問題でした

import requests

url = "https://webapi.smaregi.jp/access/"

payload='proc_name={"物理名"}&params={"limit": 1, "page": 1, "table_name": "テーブル名"}
headers = {
  'Content-Type': 'application/x-www-form-urlencoded;charset=UTF-8',
  'Accept': 'application/json',
  'X-contract-id': '{"契約ID"}',
  'X-access-token': '{"アクセストークン"}',
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

追記
requests.post()での通信の場合
GET = params
POST = data
にてパラメータを付与するようです

参考記事
https://www.yoheim.net/blog.php?q=20170802

Answer 2

form = customer_ref, *params = {
  "proc_Name":"customer_ref",
  "fields":["customerCode","lastName","firstName"],
  "conditions":[{"customerId":"213"}],
  "order":["customerCode desc"],
  "limit":100,
  "table_name":"Customer"
}

このコードでparamsに代入されるのは、['fields', 'conditions', 'order', 'limit', 'table_name']ですが、想定されているとおりですか？

そのため、

form = urllib.parse.quote(str(params))

で代入される文字列は'%5B%27fields%27%2C%20%27conditions%27%2C%20%27order%27%2C%20%27limit%27%2C%20%27table_name%27%5D'ですが、これは想定通りですか？

Comments

[yep.app]

paramsに代入される値としては、proc_Nameも入るのでは？と期待しています。
そのため、想定通りの処理ではありません、、、。

urllib.parse.quoteについては想定通りです。
スマレジAPIは「&」などの文字列を処理できないと聞いているため、
パースしています。

追記：参考文献としてスライドを載せました。

[yep.app]

`params=`とシンプルにした結果、エラーメッセージに影響ありませんが、urlのパラメータが増えました。

[Lhankor_Mhy]

requests.post の params引数には dict を渡すのがよいように思うのですが、string を渡している意図はどういったものですか？
https://requests-docs-ja.readthedocs.io/en/latest/user/quickstart/#url

[yep.app]

特に意図はありません。
しかし、
params = urllib.parse.parse_qs(params)
AttributeError: 'dict' object has no attribute 'decode'
となってしまうため、urlencodeすると文字列になりました。

[Lhankor_Mhy]

URLのクエリストリングとして文字列を渡すのであれば、一般的には"&key=value"の形にしなくてはいけないと思うのですが、それについて現状のコードはAPIの仕様に適合したリクエストになっているのですか？

どうも、うまく伝わっていない感じがしますのではっきり書きますと、
params = urllib.parse.quote(str(params))
↑この行が間違っていると思っています。