操作ガイド
Amelia API – 時間枠
ここでは、時間枠に関連するAPIエンドポイントをご覧いただけます。
認証
すべてのAmeliaエンドポイントは、Ameliaという名前のヘッダープロパティを使用したAPIキー認証を採用しています。
パス
Amelia APIのパスは以下で始まります：{{your_site_URL}}/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1
時間枠の取得
時間枠を取得します。
メソッド
このエンドポイントはGETリクエストを受け付けます。
パス
/slots
クエリパラメータ
以下のパラメータを使用できます。
| キー | タイプ | 説明 |
serviceId | integer | サービスID。必須です。 |
serviceDuration | integer | サービスの所要時間（秒単位）。必須です。 |
persons | integer | 人数。必須です。 |
providerIds | array | スタッフIDの配列。 |
locationId | integer | 場所ID |
startDateTime | string | 時間枠を取得する開始日。YYYY-MM-DD HH:mmの日時形式の文字列。 |
excludeAppointmentId | integer | 時間枠の計算に含めない予約ID。日時の変更を行う場合に使用されます。 |
extras | array | 時間枠に影響を与える可能性があるため、追加オプション（エクストラ）の配列。 |
例：
リクエスト
curl --location 'http://localhost/amelia/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/slots&locationId=2&serviceId=3&serviceDuration=1800&providerIds=3&persons=1&startDateTime=2023-09-25&extras=[]&excludeAppointmentId=null' \
--header 'Amelia: qUmkNNOLrWbf28izIgNnZ29O+7gVWL5M+8ySJ8VXq3r0'
レスポンス
{
"message": "Successfully retrieved free slots",
"data": {
"minimum": "2023-09-26 13:14",
"maximum": "2023-10-16 13:14",
"slots": {
"2023-10-02": {
"08:30": [
[
3,
2
]
],
"09:00": [
[
3,
2
]
],
"09:30": [
[
3,
2
]
],
"10:00": [
[
3,
2
]
],
"10:30": [
[
3,
2
]
],
"11:00": [
[
3,
2
]
],
"11:30": [
[
3,
2
]
],
"12:00": [
[
3,
2
]
],
"12:30": [
[
3,
2
]
],
"13:00": [
[
3,
2
]
],
"13:30": [
[
3,
2
]
],
"14:00": [
[
3,
2
]
],
"14:30": [
[
3,
2
]
]
},
"2023-10-09": {
"07:00": [
[
3,
2
]
],
"07:30": [
[
3,
2
]
],
"08:00": [
[
3,
2
]
],
"08:30": [
[
3,
2
]
],
"09:00": [
[
3,
2
]
],
"09:30": [
[
3,
2
]
],
"10:00": [
[
3,
2
]
],
"10:30": [
[
3,
2
]
],
"11:00": [
[
3,
2
]
],
"11:30": [
[
3,
2
]
],
"12:00": [
[
3,
2
]
],
"12:30": [
[
3,
2
]
],
"13:00": [
[
3,
2
]
],
"13:30": [
[
3,
2
]
],
"14:00": [
[
3,
2
]
],
"14:30": [
[
3,
2
]
]
},
"2023-10-16": {
"07:00": [
[
3,
2
]
],
"07:30": [
[
3,
2
]
],
"08:00": [
[
3,
2
]
],
"08:30": [
[
3,
2
]
],
"09:00": [
[
3,
2
]
],
"09:30": [
[
3,
2
]
],
"10:00": [
[
3,
2
]
],
"10:30": [
[
3,
2
]
],
"11:00": [
[
3,
2
]
],
"11:30": [
[
3,
2
]
],
"12:00": [
[
3,
2
]
],
"12:30": [
[
3,
2
]
],
"13:00": [
[
3,
2
]
],
"13:30": [
[
3,
2
]
],
"14:00": [
[
3,
2
]
],
"14:30": [
[
3,
2
]
]
}
},
"occupied": {
"2023-09-26": {
"07:00": [
[
3,
4,
0,
6
]
],
"08:00": [
[
3,
4,
0,
6
]
],
"09:30": [
[
3,
4,
0,
2
]
],
"11:30": [
[
3,
4,
0,
6
]
]
},
"2023-09-28": {
"13:00": [
[
3,
1,
0,
2
]
]
},
"2023-10-02": {
"07:30": [
[
3,
1,
0,
1
]
]
}
},
"busyness": {
"2023-10-02": 7,
"2023-10-09": 0,
"2023-10-16": 0
},
"lastProvider": null
}
}