操作ガイド
Amelia API – カスタム項目
ここでは、カスタム項目に関連するAPIエンドポイントをご覧いただけます。
認証
すべてのAmeliaエンドポイントは、Ameliaという名前のヘッダープロパティを使用したAPIキー認証を採用しています。
パス
Amelia APIのパスは以下で始まります：{{your_site_URL}}/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1
カスタム項目の追加
カスタム項目を作成します。
メソッド
このエンドポイントはPOSTリクエストを受け付けます。
パス
/fields
必須プロパティ
以下のプロパティは必須です。
| キー | タイプ | 説明 |
type | string | カスタム項目のタイプ。使用可能な値：text、text-area、select、checkbox、radio、content、file、datepicker、address |
オプションのプロパティ
以下のプロパティはオプションです。
| キー | タイプ | 説明 |
label | string | カスタム項目のラベル。 |
options | array | オプションの配列。select、radioタイプで使用されます。 |
position | integer | 並べ替えに使用されるカスタム項目の位置。デフォルト値は1です。 |
required | boolean | カスタム項目が必須かどうか。デフォルトはfalseです。 |
services | array | サービスIDの配列。 |
events | array | イベントIDの配列。 |
useAsLocation | boolean | カスタム項目がGoogle/Outlookカレンダーイベントの場所として使用されるかどうか。addressカスタム項目でのみ使用されます。 |
例：
リクエスト
curl --location 'http://localhost/amelia/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/fields' \
--header 'Content-Type: application/json' \
--header 'Amelia: qUmkNNOLrWbf28izIgNnZ29O+7gVWL5M+8ySJ8VXq3r0' \
--data '{ "label": "Select custom field", "options": [], "position": 3, "required": false, "services": [ { "id": 1 } ], "events": [ { "id": 120 } ], "type": "select", "useAsLocation": false }'
レスポンス
{
"message": "Successfully added new custom field.",
"data": {
"customField": {
"id": 15,
"label": "Select custom field",
"type": "select",
"required": false,
"position": 3,
"options": [],
"services": [
{
"id": 1,
"name": null,
...
}
],
"events": [
{
"id": 120,
"name": null,
...
}
],
"translations": null,
"allServices": false,
"allEvents": false,
"useAsLocation": false
}
}
}
カスタム項目の更新
カスタム項目を更新します。
メソッド
このエンドポイントはPOSTリクエストを受け付けます。
パス
/fields/{{field_id}}
オプションのプロパティ
更新したいプロパティのみを送信してください。
| キー | タイプ | 説明 |
type | string | カスタム項目のタイプ。使用可能な値：text、text-area、select、checkbox、radio、content、file、datepicker、address |
label | string | カスタム項目のラベル。 |
options | array | オプションの配列。select、radioタイプで使用されます。 |
position | integer | 並べ替えに使用されるカスタム項目の位置。デフォルト値は1です。 |
required | boolean | カスタム項目が必須かどうか。デフォルトはfalseです。 |
services | array | サービスIDの配列。 |
events | array | イベントIDの配列。 |
useAsLocation | boolean | カスタム項目がGoogle/Outlookカレンダーイベントの場所として使用されるかどうか。addressカスタム項目でのみ使用されます。 |
translations | string | ラベルの翻訳用のJSON形式の文字列。 |
allServices | boolean | カスタム項目がすべてのサービスに適用されるかどうか。デフォルトはfalseです。 |
allEvents | boolean | カスタム項目がすべてのイベントに適用されるかどうか。デフォルトはfalseです。 |
例：
リクエスト
curl --location 'http://localhost/amelia/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/fields/11' \
--header 'Content-Type: application/json' \
--header 'Amelia: qUmkNNOLrWbf28izIgNnZ29O+7gVWL5M+8ySJ8VXq3r0' \
--data '{ "label": "Select custom field", "type": "select", "required": false, "position": 3, "options": [ { "deleted": false, "edited": false, "label": "Select Option", "new": true, "position": 1 } ], "services": [ { "id": 1 } ], "events": [], "translations": null, "allServices": false, "allEvents": false, "useAsLocation": false }'
レスポンス
{
"message": "Custom field successfully updated.",
"data": {
"customField": {
"id": 11,
"label": "Select custom field",
"type": "select",
"required": false,
"position": 3,
"options": [
{
"id": 6,
"customFieldId": 3,
"label": "Select Option",
"position": 1,
"translations": null
}
],
"services": [
{
"id": 1,
"name": null,
...
}
],
"events": [],
"translations": null,
"allServices": false,
"allEvents": false,
"useAsLocation": false
}
}
}
カスタム項目の位置の更新
カスタム項目の位置を更新します。
メソッド
このエンドポイントはPOSTリクエストを受け付けます。
パス
/fields/positions
必須プロパティ
以下のプロパティは必須です。
| キー | タイプ | 説明 |
customFields | array | 新しいカスタム項目の位置の配列。 |
例：
リクエスト
curl --location 'http://localhost/amelia/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/fields/positions' \
--header 'Content-Type: application/json' \
--header 'Amelia: qUmkNNOLrWbf28izIgNnZ29O+7gVWL5M+8ySJ8VXq3r0' \
--data '{ "customFields": [ { "id": 1, "position": 1 }, { "id": 3, "position": 2 }, { "id": 2, "position": 3 } ] }'
レスポンス
{
"message": "Successfully updated custom fields positions.",
"data": null
}
}
複数のカスタム項目の取得
カスタム項目を取得します。
メソッド
このエンドポイントはGETリクエストを受け付けます。
パス
/fields
例：
リクエスト
curl --location 'http://localhost/amelia/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/fields' \
--header 'Amelia: qUmkNNOLrWbf28izIgNnZ29O+7gVWL5M+8ySJ8VXq3r0'
レスポンス
{
"message": "Successfully retrieved custom fields.",
"data": {
"customFields": [
{
"id": 1,
"label": "text",
"type": "text",
"required": false,
"position": 1,
"options": [],
"services": [],
"events": [],
"translations": null,
"allServices": true,
"allEvents": true
}
]
}
}
カスタム項目の削除
カスタム項目を削除します。
メソッド
このエンドポイントはPOSTリクエストを受け付けます。
パス
/fields/delete/{{field_id}}
例：
リクエスト
curl --location --request POST 'http://localhost/amelia/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/fields/delete/3' \
--header 'Amelia: qUmkNNOLrWbf28izIgNnZ29O+7gVWL5M+8ySJ8VXq3r0'
レスポンス
{
"message": "Successfully deleted custom field.",
"data": null
}