クライアントがRequestを送信する際のコマンドやパラメータ及びデータサイズの調べ方

Written by OnTime on . Posted in 4.2動作確認, 4.管理者, OnTime API

OnTimeはOpen APIオプションを購入することで外部からREST接続を使用して様々な情報を双方向通信可能です。
(詳細は「OnTime Open API(オプション)」を参照ください。)
制限事項はございますがオプション購入前に開発も可能です。
(詳細は「APIExplorer利用時の制限事項について」を参照ください。)

開発にあたってAPI Explorerが大変参考になるのは前述の通りですが、細かいパラメータについては実際にOnTimeクライアントを操作して、どの様なデータを渡しているかを確認するのが一番最短距離です。以下にOnTimeクライアントを利用してコマンドやパラメータを確認する方法をご紹介します。

  1. a.(Ver.4.x以前)OnTimeクライアントを起動して、下図のようにメニューから「Enable API Log」を選択してAPI Logを有効にします。
    b.(Ver.4.x以降)ConfigDBのUsersビューを開いて、下図のように操作記録対象のユーザーを選択してアクションボタンの「Debug/Enable」を実行します。
  2. 該当する操作を実際に行います。
  3. 下図のようにOnTimeGC Logデータベースを開き、「API Log」ビューを開きます。
    クライアントのOnTimeサーバーとのやりとりがRequest毎に文書として記録されています。
    2log
  4. 文書を開くと下図のようにコマンドの種類とパラメータについて参照が出来ます。
    3logdetail
  5. a.(Ver.4.x以前)確認が完了すれば、下図のようにAPI Logを無効に戻します。
    API Logはサーバーとネットワークに相当な負担がかかりますので通常運用では有効のままにしないで下さい。
    b.(Ver.4.x以降)ConfigDBのUsersビューを開いて、下図のように操作記録対象のユーザーを選択してアクションボタンの「Debug/Disable」を実行します。
    API Logはサーバーとネットワークに相当な負担がかかりますので通常運用では有効のままにしないで下さい。

開発をご委託される場合は、OnTime API開発パートナーshop@ontimesuite.jpまでご相談下さい。