APIでの取得ができない【Python】

Question

オープンロジのAPIを利用して在庫数を取得したいのですが、サイトのヘッダー情報が取得されます。
https://api.openlogi.com/doc/api.html

import requests
import json

TOKEN = '取得したトークン'
URL = 'https://api.openlogi.com'

params = {}
params['X-Api-Version'] = '1.5'
params['Authorization'] = 'Bearer' + ' ' + TOKEN
params['id'] = 1

response = requests.get(URL, params)

おそらくparamsの所が間違っていると思うのですが、
APIを初めて利用するため、これ以上わかりませんので
教えていただけないでしょうか？
商品ごとの在庫数を取得したいです。

Answer 1

X-Api-VersionとAuthorization はリクエストヘッダとして付与する必要があります。
(参照：オープンロジのドキュメント)

したがってX-Api-VersionとAuthorizationは、headers引数に指定する必要があると思います。

※下記を正常に動かすには、あらかじめOPENLOJIのページで、商品マスタに適当な商品が登録されている必要があります。
（下記IDで指定している「1」はその登録したIDに書き換えてください）
なお、APIでリクエストする際のIDの形式は、「ユーザーID-「I」+商品画面の商品一覧に表示されているIDを6桁にパディングしたもの」になっているようです。

商品IDについて

例：ユーザーIDが「ZZ542」、画面上のIDが「1」の商品の場合　→　APIで指定するIDは、「ZZ542-I000001」

import requests

TOKEN = '取得したトークン'
URL = 'https://api.openlogi.com/api/items'

headers = {}
headers['X-Api-Version'] = '1.5'
headers['Authorization'] = 'Bearer' + ' ' + TOKEN

params = {}
params['id'] = 'ZZ542-I000001'  # <---（APIアカウントID-「I」+商品ID6桁padding）

response = requests.get(URL, params=params, headers=headers)

print(response.json())

Comments

[oblada]

ありがとうございます。
取得した内容は変わったのですが、
その後「result = response.json()」で実行すると
下記のエラーが表示されます。

Expecting value: line 1 column 1 (char 0)

こちらは内容がhtmlだからと思うのですが、
このままhtmlで扱って行くのでしょうか？
それともjsonに変換する方法があるのでしょうか？

[退会済みユーザー]

URLが誤っていたため修正し、一部追記しました。

[oblada]

ありがとうございます。
修正してresultを実行すると下記が表示されます。
{'items': []}
商品IDも登録したものです。

[退会済みユーザー]

idがあっているならば取得できるはずなんですが、こちらでは、正しいidを入力した場合そのように({'items': []})なる事象を再現できませんでした。
オープンロジの公式に問い合わせた方が早いかも知れません。

[oblada]

何度もありがとうございます。
１つ目に登録した商品のIDは'1'だけでしょうか？
1つだけ商品を登録して上のコードをコピペして実行しているだけなんですけどね。
オープンロジにも問い合わせたのですが、Pythonでの対応はできないと言われたので、他の言語でも良いので教えてほしいと言っているところです。

[退会済みユーザー]

具体的な商品IDは「1」等の単純な数字ではなく
「APIのアカウントID」＋「-」（半角ハイフン）」+「I」+「6桁の0パディングした数字」になっているようです。
たとえば質問者さんのオープンロジAPIのアカウントID（オープンロジの管理画面の右上に表示されているＩＤ）が「ZZ542」ならば
商品マスタの商品一覧でIDが「１」となっている商品の
実際の商品IDは
"ZZ542-I000001"

商品マスタの商品一覧でIDが「99」となっている商品の
実際の商品IDは
"ZZ542-I000099"

となっていると思われます。

なおオープンロジAPIについて調べましたが、IDを個別に指定せずに、商品マスタに登録されている全商品の一覧を取得するやり方について記述されているページを見つけることはできませんでした。

[oblada]

できました！
ありがとうございます！！！

いくつか教えいただきたいことがあるのですが、
１、公式ページに商品IDの例としては書かれいるのですが、
教えていただいたようなパターンについて書かれていないので
自分で見抜かないといけないということでしょうか？

２、エンドポイントとして「https://api.openlogi.com」が書かれていますが、
その後ろに「api/items」が必要なのはどこに書かれているのでしょうか？

３、例えば100個の商品を抽出する場合は、
カンマ( , )区切りで商品IDを100個並べないといけないということでしょうか？

何度もありがとうございます。

[退会済みユーザー]

1. → これについては、結果としてその通り（自分で見抜かないといけない）ということになります。

実は私が最初に回答を書いたときはブラウザの管理画面経由ではなく、API（POST）で商品を登録しており、登録したときにAPIから返ってくるIDを指定して商品データの呼び出しコードをテストしていたので、
「管理画面上もIDはアカウントID＋I＋数字の形式で表示されているはず」
だと思い込んでいました。

しかし、実際にブラウザで管理画面に飛んで見たところ、管理画面上はIDが単純な数字だったので、結果として説明不足となってしまいました。すみません。

２．APIドキュメント（https://api.openlogi.com/doc/api.html#tag/items）の右側で、「GET /items　と書かれているところの下矢印」（ｖ）をクリックすると、その情報にアクセスするためのAPIエンドポイント(URL）が表示されます。
（下の図の赤丸のところをクリックします）
https://teratail-v2.storage.googleapis.com/uploads/contributed_images/5cd2ce769d96e23dbfba48e7cfe396ac.jpeg

３．for文をつかって、あらかじめidを列挙したリストを作成しておくやり方があります。
（idを6桁にするにはstr.zfill()を使う）

例）
item_ids=[]
params = {}
for i in range(100):
　item_ids.append("ZZ542-I"+str.zfill(str(i),6))
params["id"] = ",".join(item_ids)
response = requests.get(URL, params=params, headers=headers)
print(response.json())

※「ZZ542」はご自身のアカウントIDに置き換えてください。
※forの次の行のインデントは全角スペースになっているので半角スペースに直してください。

オープンロジAPIは、どうも商品マスタ一覧や入庫済みの倉庫内商品一覧を簡単に出力させるための仕組みを用意していないようです。
このことから、商品全体は別のデータベースで管理しておき、倉庫への入出庫管理の部分だけオープンロジAPIで扱う、という使い方が想定されていると思われます。

ネットを調べてみてもオープンロジに関する技術的資料がかなり少なく、難易度は高いという印象です。

[oblada]

詳しく解説いただきましてありがとうございます。

１と２は経験不足なので仕方がないです。
３の取得の仕方を教えていただきましてありがとうございます。

APIは初めの内は情報が少ないと難しいと思いました。

わざわざアカウントを作成して試していただきましてありがとうございました。
深く感謝いたします。

[退会済みユーザー]

僭越ながら、この質問の後にご自分で立てられた同じ内容の質問が、上記の回答を自己回答として解決済みとなっているのを拝見しました。
差し支えなければ、本質問も、同様にクローズしていただけますようお願い致します。
(なお、自己解決となっている先の低評価は私がつけたものではありません)

[oblada]

何しに低評価するのかわかりませんけどね。
モチベーションを下げるだけです。