操作ガイド
Amelia API – エンティティ
ここでは、エンティティに関連するAPIエンドポイントをご覧いただけます。
認証
すべてのAmeliaエンドポイントは、Ameliaという名前のヘッダープロパティを使用したAPIキー認証を採用しています。
パス
Amelia APIのパスは以下で始まります：{{your_site_URL}}/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1
エンティティの取得
エンティティを取得します。
メソッド
このエンドポイントはGETリクエストを受け付けます。
パス
/entities
クエリパラメータ
以下のパラメータを使用できます。
| キー | タイプ | 説明 |
types | string | 取得するエンティティタイプの配列。使用可能な値：スタッフ、categories（カテゴリ）、場所、コース、entitiesRelations（エンティティ関連）、customFields（カスタム項目）、お客様、services（サービス）、coupons（クーポン）、events（イベント）、tags（タグ）、appointments（予約）、settings（設定）、resources（設備・備品）、lessonSpace_spaces |
例：
リクエスト
curl --location 'http://localhost/amelia/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/entities&types=locations,events' \
--header 'Amelia: qUmkNNOLrWbf28izIgNnZ29O+7gVWL5M+8ySJ8VXq3r0'
レスポンス
{
"message": "Successfully retrieved entities",
"data": {
"events": [
{
"id": 84,
"name": "Amelia Event New Name",
"description": "",
"color": "#1788FB",
"price": 100,
"deposit": 10,
"depositPayment": "fixed",
"depositPerPerson": true,
"pictureFullPath": null,
"pictureThumbPath": null,
"extras": [],
"coupons": [],
"position": null,
"settings": "{\"payments\":{\"paymentLinks\":{\"enabled\":true,\"changeBookingStatus\":false,\"redirectUrl\":null},\"onSite\":true,\"payPal\":{\"enabled\":true},\"stripe\":{\"enabled\":true},\"mollie\":{\"enabled\":false},\"razorpay\":{\"enabled\":false}},\"general\":{\"minimumTimeRequirementPriorToCanceling\":null,\"redirectUrlAfterAppointment\":null},\"zoom\":{\"enabled\":true},\"lessonSpace\":{\"enabled\":false}}",
"fullPayment": true,
"bookings": [],
"periods": [
{
"id": 84,
"eventId": 84,
"periodStart": "2023-09-26 14:00:00",
"periodEnd": "2023-09-28 22:30:00",
"zoomMeeting": null,
"lessonSpace": null,
"bookings": [],
"googleCalendarEventId": null,
"googleMeetUrl": null,
"outlookCalendarEventId": "AQMkADAwATYwMAItZTk0ZS1lMGRmLTAwAi0wMAoARgAAA3egvCudOo1GsyywV8xCQ2wHANjP2dT7pGFAu0b6VBSGJOoAAAIBDQAAANjP2dT7pGFAu0b6VBSGJOoABrLqjugAAAA="
}
],
"bookingOpens": null,
"bookingCloses": null,
"bookingOpensRec": "same",
"bookingClosesRec": "same",
"ticketRangeRec": null,
"status": "approved",
"recurring": {
"cycle": "weekly",
"order": 4,
"until": "2023-10-08 00:00:00",
"cycleInterval": 1,
"monthlyRepeat": "each",
"monthDate": null,
"monthlyOnRepeat": null,
"monthlyOnDay": null
},
"maxCapacity": 100,
"maxCustomCapacity": null,
"show": true,
"tags": [
{
"id": 26,
"eventId": 84,
"name": "tag1"
}
],
"customTickets": [],
"gallery": [],
"providers": [],
"notifyParticipants": 1,
"locationId": 2,
"location": null,
"customLocation": null,
"parentId": 81,
"created": "2023-08-28 10:12:12",
"zoomUserId": null,
"organizerId": 1,
"type": "event",
"bringingAnyone": true,
"bookMultipleTimes": true,
"translations": null,
"customPricing": false,
"closeAfterMin": null,
"closeAfterMinBookings": false,
"maxExtraPeople": null,
"initialEventStart": null,
"initialEventEnd": null,
"aggregatedPrice": false,
"formattedPeriodStart": "September 26, 2023"
},
{
"id": 91,
"name": "event588",
"description": "",
"color": "#1788FB",
"price": 0,
"deposit": 0,
"depositPayment": "disabled",
"depositPerPerson": true,
"pictureFullPath": null,
"pictureThumbPath": null,
"extras": [],
"coupons": [],
"position": null,
"settings": "{\"payments\":{\"paymentLinks\":{\"enabled\":true,\"changeBookingStatus\":false,\"redirectUrl\":null},\"onSite\":true,\"payPal\":{\"enabled\":false},\"stripe\":{\"enabled\":false},\"mollie\":{\"enabled\":true},\"razorpay\":{\"enabled\":false}},\"general\":{\"minimumTimeRequirementPriorToCanceling\":null,\"redirectUrlAfterAppointment\":null},\"zoom\":{\"enabled\":true},\"lessonSpace\":{\"enabled\":false}}",
"fullPayment": false,
"bookings": [],
"periods": [
{
"id": 91,
"eventId": 91,
"periodStart": "2023-09-28 11:30:00",
"periodEnd": "2023-09-28 16:00:00",
"zoomMeeting": null,
"lessonSpace": null,
"bookings": [],
"googleCalendarEventId": null,
"googleMeetUrl": null,
"outlookCalendarEventId": null
}
],
"bookingOpens": null,
"bookingCloses": null,
"bookingOpensRec": "same",
"bookingClosesRec": "same",
"ticketRangeRec": null,
"status": "approved",
"recurring": null,
"maxCapacity": 6,
"maxCustomCapacity": null,
"show": true,
"tags": [],
"customTickets": [],
"gallery": [],
"providers": [],
"notifyParticipants": 1,
"locationId": null,
"location": null,
"customLocation": null,
"parentId": null,
"created": "2023-09-21 16:04:36",
"zoomUserId": null,
"organizerId": null,
"type": "event",
"bringingAnyone": true,
"bookMultipleTimes": true,
"translations": null,
"customPricing": false,
"closeAfterMin": null,
"closeAfterMinBookings": false,
"maxExtraPeople": null,
"initialEventStart": null,
"initialEventEnd": null,
"aggregatedPrice": true,
"formattedPeriodStart": "September 28, 2023"
},
{
"id": 85,
"name": "Amelia Event New Name",
"description": "",
"color": "#1788FB",
"price": 100,
"deposit": 10,
"depositPayment": "fixed",
"depositPerPerson": true,
"pictureFullPath": null,
"pictureThumbPath": null,
"extras": [],
"coupons": [],
"position": null,
"settings": "{\"payments\":{\"paymentLinks\":{\"enabled\":true,\"changeBookingStatus\":false,\"redirectUrl\":null},\"onSite\":true,\"payPal\":{\"enabled\":true},\"stripe\":{\"enabled\":true},\"mollie\":{\"enabled\":false},\"razorpay\":{\"enabled\":false}},\"general\":{\"minimumTimeRequirementPriorToCanceling\":null,\"redirectUrlAfterAppointment\":null},\"zoom\":{\"enabled\":true},\"lessonSpace\":{\"enabled\":false}}",
"fullPayment": true,
"bookings": [],
"periods": [
{
"id": 85,
"eventId": 85,
"periodStart": "2023-10-03 14:00:00",
"periodEnd": "2023-10-05 22:30:00",
"zoomMeeting": null,
"lessonSpace": null,
"bookings": [],
"googleCalendarEventId": null,
"googleMeetUrl": null,
"outlookCalendarEventId": "AQMkADAwATYwMAItZTk0ZS1lMGRmLTAwAi0wMAoARgAAA3egvCudOo1GsyywV8xCQ2wHANjP2dT7pGFAu0b6VBSGJOoAAAIBDQAAANjP2dT7pGFAu0b6VBSGJOoABrLqjukAAAA="
}
],
"bookingOpens": null,
"bookingCloses": null,
"bookingOpensRec": "same",
"bookingClosesRec": "same",
"ticketRangeRec": null,
"status": "approved",
"recurring": {
"cycle": "weekly",
"order": 5,
"until": "2023-10-08 00:00:00",
"cycleInterval": 1,
"monthlyRepeat": "each",
"monthDate": null,
"monthlyOnRepeat": null,
"monthlyOnDay": null
},
"maxCapacity": 100,
"maxCustomCapacity": null,
"show": true,
"tags": [
{
"id": 27,
"eventId": 85,
"name": "tag1"
}
],
"customTickets": [],
"gallery": [],
"providers": [],
"notifyParticipants": 1,
"locationId": 2,
"location": null,
"customLocation": null,
"parentId": 81,
"created": "2023-08-28 10:12:12",
"zoomUserId": null,
"organizerId": 1,
"type": "event",
"bringingAnyone": true,
"bookMultipleTimes": true,
"translations": null,
"customPricing": false,
"closeAfterMin": null,
"closeAfterMinBookings": false,
"maxExtraPeople": null,
"initialEventStart": null,
"initialEventEnd": null,
"aggregatedPrice": false,
"formattedPeriodStart": "October 3, 2023"
}
],
"locations": [
{
"id": 4,
"status": "visible",
"name": "179 West Drive",
"description": "Description of location",
"address": "169 W North Ave, Northlake, IL, USA",
"phone": "+381601234567",
"latitude": 41.906876,
"longitude": -87.896297,
"pictureFullPath": null,
"pictureThumbPath": null,
"pin": null,
"translations": null
},
{
"id": 2,
"status": "visible",
"name": "Location2",
"description": "",
"address": "Velisava Vulovića 18, Belgrade, Serbia",
"phone": "",
"latitude": 44.767476,
"longitude": 20.455081,
"pictureFullPath": null,
"pictureThumbPath": null,
"pin": "",
"translations": null
},
{
"id": 1,
"status": "visible",
"name": "mARSALA tITA 96",
"description": "Description of location Marsala Tita",
"address": "Marsala Tita 96, Visnjica",
"phone": "+381601234567",
"latitude": 41.906876,
"longitude": -87.896297,
"pictureFullPath": null,
"pictureThumbPath": null,
"pin": "http://localhost/amelia/wp-content/plugins/amelia-plugin//public/img/pins/orange.png",
"translations": null
}
],
"customers": [],
"appointments": {
"futureAppointments": []
}
}
}