# قفل، خرید و بررسی # خرید آیتم جستجو شده – Book این API به‌طور اختصاصی برای انجام عملیات رزرو چارتری طراحی شده است. از طریق این API تنها می‌توانید درخواست‌های رزرو جدید برای چارتری ارسال کنید و اطلاعات مربوط به رزرو انجام شده را دریافت نمایید. # رزرو از طریق API
**عنوان****وضعیت****مقادیر****توضیحات**
MethodاجباریPOSTمتد ارسال درخواست
Domainاجبارینام دامنه ثبت شده در اتوماسیون
Api Urlاجباریدامنه هسته مرکزی سرویس
Api versionاجباریبه نسخه فعلی سرویس API تلقی میشود که در قسمت [پیش نیازهای اتوماسیون](https://airplus.app/docs/%d9%be%db%8c%d8%b4-%d9%86%db%8c%d8%a7%d8%b2%d9%87%d8%a7-%d9%88-%d8%b4%d8%b1%d8%a7%db%8c%d8%b7-%d8%a7%d8%ae%d8%b0-api-%da%86%d8%a7%d8%b1%d8%aa%d8%b1%db%8c/) به ریز شرح داده شده است.
Authorizationاجباریتوکن JWT تولید شدهاین توکن بصورت JWT تولید میشود.
در این روش شما باید درخواست خود را از طریق لینک زیر ارسال فرمائید. # سربرگ – Header ``` {{Api Url}}/book HEADER POST /api/reservation/{{Api version}}/book HTTP/1.1 Host: {{Your Host}} Content-Type: application/json Authorization: Bearer JWTToken Domain: {{Your Domain}} ``` API Url از طریق پنل کاربری قابل مشاهده خواهد بود. # مقادیر ارسالی – Request Data
**عنوان****نوع****وضعیت****مقادیر****توضیحات**
main\_idIntegerاجباریعطف چارتر
itemsArray تعداد آیتم های این فیلد متناسب با چارتر های انتخابی افزایش میابد
items\[index\].idIntegerاجباریآیدی کلاس چارتر
items\[index\].lock\_idIntegerاجباریآیدی قفل رزرو
items\[index\].local\_pnrStringاجباریpnr داخلی
items\[index\].amountIntegerاجباریمجموع قیمت
items\[index\].passengersArray
items\[index\].passengers\[index\].genderStringاجباریmale/female
items\[index\].passengers\[index\].fullname
items\[index\].passengers\[index\].fullname.first\_name
items\[index\].passengers\[index\].fullname.first\_name.enStringاجبارینام مسافر به صورت لاتین
items\[index\].passengers\[index\].fullname.first\_name.faStringاجبارینام مسافر به صورت فارسی
items\[index\].passengers\[index\].fullname.last\_name
items\[index\].passengers\[index\].fullname.last\_name.enStringاجبارینام خانوادگی مسافر به صورت لاتین
items\[index\].passengers\[index\].fullname.last\_name.faStringاجبارینام خانوادگی مسافر به صورت فارسی
items\[index\].passengers\[index\].identity
items\[index\].passengers\[index\].identity.nationalityStringاجباری
items\[index\].passengers\[index\].identity.idStringاجباری
items\[index\].passengers\[index\].passport
items\[index\].passengers\[index\].passport.idStringاجباری
items\[index\].passengers\[index\].passport.expire\_atStringاجباری
items\[index\].passengers\[index\].birthStringاجباری
items\[index\].passengers\[index\].mobileStringاجباری
items\[index\].passengers\[index\].emailStringاجباری
``` { "main_id": 10001, "items": [ { "id": 10001, "lock_id": 20005, "local_pnr": "DFEfs213", "amount": 7, // Integer "passengers": [ { "gender": "male", //male , female "fullname": { "first_name": { "en": "", // first name en "fa": "" // first name fa }, "last_name": { "en": "", // last name en "fa": "" // last name fa } }, "identity": { "nationality": "IR", "id": "" // national code }, "passport": { "id": false, "expire_at": false }, "birth": "1994-05-14", "mobile": "", // phone number "email": false }, ... ] }, ... ] } ``` # پاسخ صحیح – Response True جواب این api به صورت آرایه میباشد
**عنوان****نوع****مقادیر****توضیحات**
**items**Array
items\[index\].statusBooleantrue/falseهنگام رزرو یک چارتر با موفقیت مقدار این کلید true خواهد بود و در صورت بروز ارور این کلید false خواهد شد و مثل رویه های قبلی برای مشاهده دلیل ارور با توجه به error code به صفحه error handling مراجعه فرمایید.
**items\[index\].pnr**
items\[index\].pnr.localStringpnr داخلی
items\[index\].pnr.originalStringpnr اصلی
items\[index\].pnr.idIntegerشماره بلیت
items\[index\].item\_idInteger هنگامی که کلید status برابر با false باشد این کلید وجود خواهد داشت.
items\[index\].codeIntegerشماره خطا مربوطههنگامی که کلید status برابر با false باشد این کلید وجود خواهد داشت که باید جهت استعلام خطا میتوانید از طریق [این لینک](https://airplus.app/docs/%d9%85%d8%af%db%8c%d8%b1%db%8c%d8%aa-%d8%ae%d8%b7%d8%a7%d9%87%d8%a7-error-handling/) اقدام کنید.
**meta**
meta.timestampTimestamp زمان تولید پاسخ این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود.
دریافت این پاسخ با Status Code 200 دریافت خواهد شد. ``` { "items": [ { "status": true, "pnr": { "local": "D0Efs213", "original": "htLQgDxD", "id": 10013 } }, { "status": false, "item_id": 10001, "code": 1006 }, ... ], "meta": { "timestamp": "Timestamp" // Timestamp } } ```
# پاسخ نادرست – Response False
**عنوان****نوع****مقادیر****توضیحات**
**error**
error.codeIntegerشماره خطا مربوطهجهت استعلام خطا میتوانید از طریق [این لینک](https://airplus.app/docs/%d9%85%d8%af%db%8c%d8%b1%db%8c%d8%aa-%d8%ae%d8%b7%d8%a7%d9%87%d8%a7-error-handling/) اقدام کنید.
**meta**
meta.timestampTimestamp زمان تولید پاسخ این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود.
``` { "error": { "code":"Error Code" }, "meta": { "timestamp": "Timestamp" // Timestamp } } ``` در صورت مشاهده Status Code 404 URL درخواست خود را به اشتباه وارد نمود اید. # آخرین وضعیت آیتم خریداری شده – Book Status در این بخش میتوانید از وضعیت رزرو خود مطلع شوید. # اطلاع از وضعیت رزرو از طریق API
**عنوان****وضعیت****مقادیر****توضیحات**
MethodاجباریGETمتد ارسال درخواست
Domainاجبارینام دامنه ثبت شده در اتوماسیون
Api Urlاجباریدامنه هسته مرکزی سرویس
Api versionاجباریبه نسخه فعلی سرویس API تلقی میشود که در قسمت [پیش نیازهای اتوماسیون](https://airplus.app/docs/%d9%be%db%8c%d8%b4-%d9%86%db%8c%d8%a7%d8%b2%d9%87%d8%a7-%d9%88-%d8%b4%d8%b1%d8%a7%db%8c%d8%b7-%d8%a7%d8%ae%d8%b0-api-%da%86%d8%a7%d8%b1%d8%aa%d8%b1%db%8c/) به ریز شرح داده شده است.
Authorizationاجباریتوکن JWT تولید شدهاین توکن بصورت JWT تولید میشود.
در این روش شما باید درخواست خود را از طریق لینک زیر ارسال فرمائید. # سربرگ – Header ``` {{Api Url}}/book/status HEADER GET /api/reservation/{{Api version}}/book/status HTTP/1.1 Host: {{Your Host}} Content-Type: application/json Authorization: Bearer JWTToken Domain: {{Your Domain}} ``` API Url از طریق پنل کاربری قابل مشاهده خواهد بود. # مقادیر ارسالی – Request Data
**عنوان****نوع****وضعیت****مقادیر****توضیحات**
local\_pnrStringاجباریpnr داخلی
``` { "local_pnr": "" } ``` # پاسخ صحیح – Response True
**عنوان****نوع****مقادیر****توضیحات**
**payload**
payload.statusStringconfirmed/canceled/refund/doneهنگام تایید مقدار کلید برابر با confirmed خواهد بود و هنگام کنسل شدن برابر با canceled خواهد بود و اگر استرداد شده بود برابر با refund و اگر پرواز انجام شده بود برابر با مقدار done خواهد بود.
**payload.pnr**
payload.pnr.localStringpnr داخلی
payload.pnr.originalStringpnr اصلی
payload.pnr.numberIntegerشماره بلیت
**payload.refund** اگر مقدار کلید payload.status برابر با refund بود این کلید وجود خواهد داشت.
payload.refund.idInteger
**meta**
meta.timestampTimestamp زمان تولید پاسخ این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود.
دریافت این پاسخ با Status Code 200 دریافت خواهد شد. ``` { "payload": { "status": "refund", "pnr": { "local": "", "original": "", "number": 10011 }, "refund": { "id": 10007 } }, "meta": { "timestamp": "Timestamp" // Timestamp } } ``` # پاسخ نادرست – Response False
**عنوان****نوع****مقادیر****توضیحات**
**error**
error.codeIntegerشماره خطا مربوطهجهت استعلام خطا میتوانید از طریق [این لینک](https://airplus.app/docs/%d9%85%d8%af%db%8c%d8%b1%db%8c%d8%aa-%d8%ae%d8%b7%d8%a7%d9%87%d8%a7-error-handling/) اقدام کنید.
**meta**
meta.timestampTimestamp زمان تولید پاسخ این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود.
``` { "error": { "code":"Error Code" }, "meta": { "timestamp": "Timestamp" // Timestamp } } ``` در صورت مشاهده Status Code 404 URL درخواست خود را به اشتباه وارد نمود اید.
# قفل آیتم جستجو شده – Lock در این بخش شما میتوانید آیتم جستجو شده ی خود را جهت رزرو قفل کنید. # قفل آیتم از طریق API
**عنوان****وضعیت****مقادیر****توضیحات**
MethodاجباریPOSTمتد ارسال درخواست
Domainاجبارینام دامنه ثبت شده در اتوماسیون
Api Urlاجباریدامنه هسته مرکزی سرویس
Api versionاجباریبه نسخه فعلی سرویس API تلقی میشود که در قسمت [پیش نیازهای اتوماسیون](https://airplus.app/docs/%d9%be%db%8c%d8%b4-%d9%86%db%8c%d8%a7%d8%b2%d9%87%d8%a7-%d9%88-%d8%b4%d8%b1%d8%a7%db%8c%d8%b7-%d8%a7%d8%ae%d8%b0-api-%da%86%d8%a7%d8%b1%d8%aa%d8%b1%db%8c/) به ریز شرح داده شده است.
Authorizationاجباریتوکن JWT تولید شدهاین توکن بصورت JWT تولید میشود.
در این روش شما باید درخواست خود را از طریق لینک زیر ارسال فرمائید. # سربرگ – Header ``` {{Api Url}}/lock HEADER POST /api/reservation/{{Api version}}/lock HTTP/1.1 Host: {{Your Host}} Content-Type: application/json Authorization: Bearer JWTToken Domain: {{Your Domain}} ``` API Url از طریق پنل کاربری قابل مشاهده خواهد بود. # مقادیر ارسالی – Request Data
**عنوان****نوع****وضعیت****مقادیر****توضیحات**
chartersArrayاجباری آیتم های این کلید متناسب با تعداد چارتر های انتخاب شده تغییر میکند.
charters\[index\].idIntegerاجباری
charters\[index\].item\_idIntegerاجباری
**charters\[index\].passengers**
charters\[index\].passengers.adultIntegerاجباری
charters\[index\].passengers.infantIntegerاجباری
``` { "charters": [ { "id": 10002, "item_id": 10005, "passengers": { "adult": 2, "infant": 1 } }, ... ] } ``` # پاسخ صحیح – Response True
**عنوان****نوع****مقادیر****توضیحات**
**items**Array
items\[index\].idInteger
items\[index\].statusBooleantrue/falseممکن است مقدارش true باشد و ممکن است بعضی از ایتم ها قفل نشوند بنابراین مقدار این کلید در آن آیتم ها false خواهد بود.
items\[index\].lock\_idIntegerآیدی قفل رزروهنگامی که کلید status true باشد این کلید وجود دارد
items\[index\].durationIntegerمدت زمان قفل رزروهنگامی که کلید status true باشد این کلید وجود دارد
items\[index\].expirationStringزمان انقضای قفل رزروهنگامی که کلید status true باشد این کلید وجود دارد
items\[index\].codeIntegercode errorهنگامی که کلید status false باشد این کلید وجود دارد که مثل رویه های قبلی باید به صفحه error handling برای مشاهده دلیل ارور خود مراجعه فرمایید.
**meta**
meta.timestampTimestamp زمان تولید پاسخ این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود.
دریافت این پاسخ با Status Code 200 دریافت خواهد شد. ``` { "items": [ { "id": 10001, "status": true, "lock_id": 20018, "duration": 5, "expiration": "2025-01-20 13:30:47" }, { "id": 10002, "status": false, "code": 1002 }, ... ], "meta": { "timestamp": "Timestamp" // Timestamp } } ``` # پاسخ نادرست – Response False
**عنوان****نوع****مقادیر****توضیحات**
**error**
error.codeIntegerشماره خطا مربوطهجهت استعلام خطا میتوانید از طریق [این لینک](https://airplus.app/docs/%d9%85%d8%af%db%8c%d8%b1%db%8c%d8%aa-%d8%ae%d8%b7%d8%a7%d9%87%d8%a7-error-handling/) اقدام کنید.
**meta**
meta.timestampTimestamp زمان تولید پاسخ این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود.
``` { "error": { "code":"Error Code" }, "meta": { "timestamp": "Timestamp" // Timestamp } } ``` در صورت مشاهده Status Code 404 URL درخواست خود را به اشتباه وارد نمود اید. # لغو قفل انجام شده – Unlock در این بخش شما میتوانید قفل یک رزرو را که قبلا با استفاده از api lock انجام داده اید لغو کنید. # لغو قفل آیتم از طریق API
**عنوان****وضعیت****مقادیر****توضیحات**
MethodاجباریPOSTمتد ارسال درخواست
Domainاجبارینام دامنه ثبت شده در اتوماسیون
Api Urlاجباریدامنه هسته مرکزی سرویس
Api versionاجباریبه نسخه فعلی سرویس API تلقی میشود که در قسمت [پیش نیازهای اتوماسیون](https://airplus.app/docs/%d9%be%db%8c%d8%b4-%d9%86%db%8c%d8%a7%d8%b2%d9%87%d8%a7-%d9%88-%d8%b4%d8%b1%d8%a7%db%8c%d8%b7-%d8%a7%d8%ae%d8%b0-api-%da%86%d8%a7%d8%b1%d8%aa%d8%b1%db%8c/) به ریز شرح داده شده است.
Authorizationاجباریتوکن JWT تولید شدهاین توکن بصورت JWT تولید میشود.
در این روش شما باید درخواست خود را از طریق لینک زیر ارسال فرمائید. # سربرگ – Header ``` {{Api Url}}/unlock HEADER POST /api/reservation/{{Api version}}/unlock HTTP/1.1 Host: {{Your Host}} Content-Type: application/json Authorization: Bearer JWTToken Domain: {{Your Domain}} ``` API Url از طریق پنل کاربری قابل مشاهده خواهد بود. # مقادیر ارسالی – Request Data
**عنوان****نوع****وضعیت****مقادیر****توضیحات**
lock\_idIntegerاجباریآیدی قفل آیتم مربوطه
``` { "lock_id": 20021 } ``` هنگامی که فرآیند لغو قفل رزرو با موفقیت انجام شود status code درخواست برابر با 204 خواهد بود و جوابی برای این api وجود ندارد. # پاسخ نادرست – Response False
**عنوان****نوع****مقادیر****توضیحات**
**error**
error.codeIntegerشماره خطا مربوطهجهت استعلام خطا میتوانید از طریق [این لینک](https://airplus.app/docs/%d9%85%d8%af%db%8c%d8%b1%db%8c%d8%aa-%d8%ae%d8%b7%d8%a7%d9%87%d8%a7-error-handling/) اقدام کنید.
**meta**
meta.timestampTimestamp زمان تولید پاسخ این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود.
``` { "error": { "code":"Error Code" }, "meta": { "timestamp": "Timestamp" // Timestamp } } ``` در صورت مشاهده Status Code 404 URL درخواست خود را به اشتباه وارد نمود اید. # لیست خریدها – Book History (بزودی) # بزودی…