SmartHR API 仕様書について

SmartHR APIの仕様についてのドキュメント「SmartHR API仕様書」（以下、API仕様書という）について説明します。

API仕様書では、仕様確認のほか、実際にAPIのリクエストを試すことができます。

［RESPONSE SAMPLE］［RESPONSE SCHEMA］について

画面右にある［Show samples </>］をクリックすると、［RESPONSE SAMPLE］と［RESPONSE SCHEMA］の項目が表示されます。

区分値の物理名と論理名の対応は、SmartHR API 区分値リストをご確認ください。

［RESPONSE SAMPLE］は、リクエストした際のレスポンスのサンプルです。

［RESPONSE SCHEMA］は、レスポンスを定義したものです。物理名・論理名の定義、各プロパティのデータタイプの定義、各プロパティが必須か、またはオプションか、などを示しています。

［RESPONSE SAMPLE］と［RESPONSE SCHEMA］を参考に、JSON文字列を構築してリクエストしてください。

SmartHRに登録しているデータを用いたAPIのテスト（レスポンス確認）ができます。

画面左上にある ［TENANT ID］［TOKEN］に、SmartHRでのサブドメインとアクセストークンを入力し、［→］をクリックすると、実行したレスポンスの確認ができます。