REST API仕様¶
REST API共通パラメータ仕様¶
リクエストパラメータ共通仕様¶
クライアントからREST APIに要求する共通パラメータを以下の表に示します。
セクション パラメータ タイプ 必須 設定値 意味 備考 system ハッシュ 必須 以下のパラメータを設定。 REST API共通情報設定セクション login_name 文字列 必須 任意 認証ユーザ名 利用申請時に発行されます。 login_pass 文字列 必須 任意 認証ユーザパスワード 利用申請時に発行されます。 app_servername 文字列 必須 任意 REST API呼び出し元サーバ名 障害発生時に弊社側でトレースに利用します。特に不要な場合は、空文字を設定します。app_username 文字列 必須 任意 REST API呼び出し元ユーザ名 障害発生時に弊社側でトレースに利用します。特に不要な場合は、空文字を設定します。timezone 文字列 必須 空文字 タイムゾーン情報(応答情報の時刻情報の変換に利用) 将来性を見込んだパラメータであるため、現在は空文字のみ受け付けます。本システムはAsia/Tokyoのタイムゾーンで稼働します。use_rawdata 文字列 必須 0:通常データのみ、1:生データ利用 登録/検索データ種別(生データ登録/検索) 生データは、登録情報の元データ(XMLなど)のことを指します。 query ハッシュ 必須 REST API毎のパラメータを設定 REST API毎の情報設定セクション 詳細はAPI毎の仕様を参照。
レスポンスパラメータ共通仕様¶
REST APIからクライアントに応答する共通パラメータを以下の表に示します。
パラメータ タイプ 意味 備考 code 文字列 API実行結果の応答コード message 文字列 API実行結果の応答詳細メッセージ codeに設定される値を以下に示します。
200:処理成功 401:認証エラー(ユーザ名またはパスワード誤り、許可されないデータタイプ名を指定した) 550:パラメータエラー 551:pre hook関数処理エラー 552:post hook関数処理エラー 553:非実装エラー 500:その他内部エラー
認証¶
- APIを利用するには、認証のためにユーザＩＤとパスワードを利用します。
- ユーザＩＤとパスワードは利用申請時に発行されます。
- 認証はREST API呼び出し時のパラメータに認証情報を含めることで行います。
pre hook処理¶
- データの登録または検索前に固有の処理が必要な場合に、処理を行います。
- 利用をご要望の際は、別途ご相談ください。
- 利用例
- 別システムからデータを取得し、取得したデータをキーとして本システムを利用する。
- データの登録を行う前に、データの変換などを行う。
post hook処理¶
- データの登録または検索後に固有の処理が必要な場合に、処理を行います。
- 利用をご要望の際は、別途ご相談ください。
- 利用例
- データの格納形式とアプリの利用形式が異なるため、データの変換を行う。