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 | 一時的にサービスを停止しています。(メンテナンス等) |
Related Articles
ChoiceRESERVE API とは
時間タイプ スクールタイプ 会議室タイプ イベントタイプ ChoiceRESERVE APIとは 予約情報などChoiceRESERVE内の情報を操作するRESTfulなインターフェースを提供します。 ChoiceRESERVE APIご利用にあたり ご契約と料金に関して ChoiceRESERVE APIをご利用になるには、ChoiceRESERVEのご契約に加え有償オプションのお申し込みが必要となります。また、ChoiceRESERVE ...サンプルプログラム
時間タイプ スクールタイプ 会議室タイプ イベントタイプ 予約データ一覧を取得するサンプルプログラム(PHP) <?php $handle = curl_init(); $url = 'https://[予約サイトURL]/api/v2/reservations'; $api_key = '[APIキー]'; // リクエストパラメータ $params = [ 'offset' => 0, 'count' => 10, 'registered_datetime_from' => ...予約メニュー | 対応予約アンケート（メインメニュー）の取得
時間タイプ スクールタイプ 会議室タイプ イベントタイプ ご契約と料金に関して ChoiceRESERVE APIをご利用になるには、ChoiceRESERVEのご契約に加え有償オプションのお申し込みが必要となります。また、参照系APIは予約データ、予約メニュー、時間割(スクールタイプのみ)と3種類あり、それぞれでご契約が必要です。 尚、ご契約前にAPIをお試しされたい場合や料金についてはお問い合わせください。 メソッド GET URL ...予約メニュー | 対応予約オプション（メインメニュー）の取得
時間タイプ スクールタイプ 会議室タイプ イベントタイプ ご契約と料金に関して ChoiceRESERVE APIをご利用になるには、ChoiceRESERVEのご契約に加え有償オプションのお申し込みが必要となります。また、参照系APIは予約データ、予約メニュー、時間割(スクールタイプのみ)と3種類あり、それぞれでご契約が必要です。 尚、ご契約前にAPIをお試しされたい場合や料金についてはお問い合わせください。 メソッド GET URL /api/v2/main_option_relations ...予約メニュー | カテゴリの取得
時間タイプ スクールタイプ 会議室タイプ イベントタイプ ご契約と料金に関して ChoiceRESERVE APIをご利用になるには、ChoiceRESERVEのご契約に加え有償オプションのお申し込みが必要となります。また、参照系APIは予約データ、予約メニュー、時間割(スクールタイプのみ)と3種類あり、それぞれでご契約が必要です。 尚、ご契約前にAPIをお試しされたい場合や料金についてはお問い合わせください。 メソッド GET URL /api/v2/categories クエリパラメータ ...