スマレジ・プラットフォームAPIの設計書・仕様書をいただきたい
依頼としましては下記2点ございます。
①スマレジ・プラットフォームAPIのレスポンスパラメータの論理名および型が定義されている資料をいただきたい
●背景
例をあげますと、取引取得APIのレスポンスパラメータでtotalという項目があります。おそらく金額の合計だと思います。よって、数値型が本来適切に見えます。（POS仕様書上はstring型ですが）
しかし、論理名もなく型がstringなので実際はint型に変換後、変換できない場合のプログラムまで作る必要がでてきます。
実際は不要な変換なのに実装・テストをしなければならなくなります。API的にint型しかありえないことが確認取れれば、実装時で不要なパースとチェック処理が省けるためです。
②スマレジ・プラットフォームAPIで使用するコードの一覧の資料をいただきたい
●背景
スマレジで定義されているコード値を、弊社で実装するシステムのコード値に変換する処理が必要かを判断するため。またはテスト設計を行う上で利用したいため
以上、よろしくお願いいたします。
答え
@SSS 上村
お問い合わせありがとうございます。
この度は、弊社仕様書の記載が不十分で、ご迷惑をおかけしており、誠に申し訳ございません。
①スマレジ・プラットフォームAPIのレスポンスパラメータの論理名および型が定義されている資料をいただきたい
スマレジ・プラットフォームAPI(POS)では、リクエストパラメータを、その項目の性質（整数値・実数値・文字列などの入力項目から想定されるデータ型）に問わず、null指定を除いて、全てstring型で作成していただく作りであり、レスポンスパラメータについてもリクエストのデータ型と統一する目的のため、string型で返却しております。(null項目などを除く）
レスポンスパラメータのうち、登録・更新系APIでリクエストパラメータとして受け付けているものについては、同様の仕様に沿った値をレスポンスパラメータとして返却しております。（ほぼ全ての項目が登録・更新APIで指定できるように作成しております）
ご提示いただいた取引取得APIのtotalであれば、取引登録APIのtotalをご覧いただけますと、データ型がintであることや桁数の範囲、また制約条件などについても記載されておりますので、こちらをご参照いただければと思います。
ご要望の論理名及び型が定義されている資料のご提示ですが、一覧としてのご用意については上述のリクエストパラメータの情報を除いては用意しておりません。リクエストパラメータに記載の情報以上に関しては現状各項目について個別にご回答差し上げておりますので、ご不明な点についてはご質問いただけますと幸いです。
②スマレジ・プラットフォームAPIで使用するコードの一覧の資料をいただきたい
こちらにつきましても、現在、一覧として弊社で指定しているコード値・定数の情報は提供しておりません。
ご不便をおかけして申し訳ございませんが、①の質問と同様に、レスポンスパラメータに記載がない場合は、登録・更新APIのリクエストパラメータの各説明に、その項目でとりうるコード値について説明が記載されておりますので、そちらをご参照くださいませ。ご不明な点がございましたら、ご質問いただけますと幸いです。
また、本日ご要望いただきました
上記につきましては、後のプラットフォームAPIのバージョンアップ時の内容として検討させていただきます。
また、現在検討中の内容で恐縮ですが、今後の内容として、
上記対応について、現在検討中でございます。（こちらは現在検討中の対応であるため、実際のバージョンアップ内容と異なる場合がございますこと、ご承知おきください。）
重ねてになりますが、弊社プラットフォームAPI仕様書(POS)の記載内容が不十分で、ご迷惑をおかけいたしましたことお詫び申し上げます。