プラットフォームAPIとユーザー用スマレジAPIについて

プラットフォームAPIとユーザー用スマレジAPIについてですが

データ仕様等確認すると若干差異があり、2つのAPIは別物ということでよろしいでしょうか。


また、プラットフォームAPIのWebhook機能はユーザ用スマレジAPIの

スマレジデータ送信機能(PUSH機能)と同等と考えてもよろしいでしょうか。


開発アカウントではユーザ用スマレジAPIの設定がありませんが

テストは行えないでしょうか。

答え

  • @福島

    プラットフォームAPIとユーザー用スマレジAPIについてですが

    データ仕様等確認すると若干差異があり、2つのAPIは別物ということでよろしいでしょうか。

    別物です。

    ユーザー用スマレジAPIはWebAPI v2と定義されています。古いAPI仕様で、更にスマレジ購入者のみ利用することができます。

    対して、

    プラットフォームAPIはv4と定義されています。v2を踏襲して一部新しく改訂されています。これはデベロッパーズに登録すれば開発者がサンドボックスでAPIを利用でき、アプリを購入すれば利用者がプロダクションでAPIを利用することができます。

    クライアント情報の発行手順的には事実上、

    • v2は購入した利用者(開発者ではない)がAPIを使って拡張する
    • v4はデベロッパー登録した開発者がAPIを使って拡張する

    というふうにAPIを具体的に実装するユーザー想定が違います。


    プラットフォームAPIのWebhook機能はユーザ用スマレジAPIの

    スマレジデータ送信機能(PUSH機能)と同等と考えてもよろしいでしょうか。

    機能的には同等です。インフラ部分でさらなる安定化とセキュリティの強化はしていますが、大差無いです。

    仕様的にはWebhook通知時にIDを送付し、そのIDを使用して取得していただく手法に切り替えている箇所があります。


    開発アカウントではユーザ用スマレジAPIの設定がありませんが

    テストは行えないでしょうか。

    できません。

    v2はサンドボックスでは開放しておりませんので、その場合は実際にスマレジを購入するか、既に利用しているお客様の環境でテストしていただくことになります。


    何か他に疑問点ございましたら、コメントしてくださいませ。

    よろしくお願いいたします