MENU

料金プラン

機能一覧

デモ

ご利用の流れ

お役立ちコラム



時間枠の検索

操作ガイド

Amelia API – 時間枠の検索

ここでは、検索フォーム用の時間枠に関連するAPIエンドポイントをご覧いただけます。

すべてのAPIエンドポイントと、リクエストおよびレスポンスの例は、こちらからダウンロードできるAmelia API Postmanコレクションで確認できます。

APIエンドポイントの使用には、一定のコーディングスキルが必要であり、プラグインで提供されるサポートには含まれていません。

認証

すべてのAmeliaエンドポイントは、Ameliaという名前のヘッダープロパティを使用したAPIキー認証を採用しています。

パス

Amelia APIのパスは以下で始まります:{{your_site_URL}}/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1

時間枠の取得

時間枠を取得します。

メソッド

このエンドポイントはGETリクエストを受け付けます。

パス

/search

クエリパラメータ

以下のパラメータを使用できます。

キータイプ説明
datestring時間枠を検索する日付。形式:YYYY-MM-DD。必須です。
servicesarrayサービスIDの配列。
providersarrayスタッフIDの配列。
locationinteger場所ID。
timeFromstring時間枠を検索する開始時刻。形式:HH:mm:ss
timeTostring時間枠を検索する終了時刻。形式:HH:mm:ss
pageintegerページ番号。
sortstringサービスの並べ替え方法。使用可能な値:nameまたはprice。空の値は、管理者側での位置(デフォルトの動作)でサービスを並べ替えます。

リクエスト
curl --location 'http://localhost/amelia/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/search&date=2023-09-27&location=2&page=1&services=1,2&sort=name&providers=1,3' \
--header 'Amelia: qUmkNNOLrWbf28izIgNnZ29O+7gVWL5M+8ySJ8VXq3r0'
レスポンス
{
"message": "Successfully retrieved searched services.",
"data": {
"providersServices": [
{
"1": 1,
"places": null,
"locations": [
2
],
"price": 23
},
{
"2": 1,
"places": null,
"locations": [
2
],
"price": 0
}
],
"total": 2
}
}