API共通仕様

API共通仕様

  • 時間タイプ
  • スクールタイプ
  • 会議室タイプ
  • イベントタイプ

共通仕様

接続先

ユーザーサイト(予約サイト)のURLで接続をお願い致します

〇　https://*****.resv.jp/api/v2/
×　https://manage-*****.resv.jp/api/v2/
※注 ***** は、ご利用中のアカウント名です。（ _ は－に変換してください）

レスポンス形式

json形式

認証について

管理画面で発行するAPI Keyを利用し認証を行います。API Keyはリクエストヘッダ(Authorization)に付加頂きます。

HTTPリクエストヘッダ

ヘッダ名 型 必須 値
Authorization 文字列 〇 管理画面で発行されたAPI Key

エラーレスポンス

エラーが発生した場合は、エラーコードとエラーメッセージがそれぞれレスポンスヘッダ、レスポンスボディにセットされます。

サンプル：認証が失敗した場合

レスポンスヘッダ

  • HTTP/1.1 401 Unauthorized
    Content-Type: application/json; charset=utf-8
    Content-Language: ja

レスポンスボディ

  • {
  •    "title" :"認証エラー",
  •    "detail" :"認証キーを確認してください"
  • }

エラーコード一覧


コード 内容
400 パラメータにデータ形式などの誤りがあります。（登録系APIの場合はURLで指定した id が存在しない場合を含みます）
401 認証情報に誤りがある、もしくはAuthorizationヘッダがありません。
403 アクセス権限がありません。
404 リクエスト先が存在しません。
415 リクエストヘッダの「Content-Type」は「application/json」を設定してください。
429 分間の最大リクエスト数の制限を超えています。(レート制限)
500 サーバーエラーが発生しています。
501 指定したリクエストメソッドには対応していません。
503 一時的にサービスを停止しています。(メンテナンス等)

結果セットの暗号化

API設定画面でレスポンスを「共通鍵方式で暗号化する」に設定している場合
APIレスポンスのresultsが暗号化されたencrypted_resultsに置き換わります。

encrypted_results 文字列

  • [IV(固定長12バイト)] + [Tag(固定長16バイト)] + [Ciphertext(可変長)] をbase64エンコードした文字列
オフセット 長さ 項目 説明
0 12バイト IV 暗号化ごとに生成されるランダムな初期化ベクトル
12 16バイト Tag 改ざん検知用の認証タグ
28 可変長 Ciphertext resultsのJSON文字列を暗号化したデータ

上記のデータとAPI設定画面の共通鍵を用いて暗号化アルゴリズム「AES-256-GCM」で復号してください。
※API設定画面の共通鍵は16進数表示です、必ずバイナリ文字列に変換して利用してください。

具体的な手順についてはサンプルプログラムを参考にしてください。