این API بهطور اختصاصی برای انجام عملیات رزرو چارتری طراحی شده است. از طریق این API تنها میتوانید درخواستهای رزرو جدید برای چارتری ارسال کنید و اطلاعات مربوط به رزرو انجام شده را دریافت نمایید.
رزرو از طریق API: #
عنوان | وضعیت | مقادیر | توضیحات |
Method | اجباری | POST | متد ارسال درخواست |
Domain | اجباری | نام دامنه ثبت شده در اتوماسیون | |
Api Url | اجباری | دامنه هسته مرکزی سرویس | |
Api version | اجباری | به نسخه فعلی سرویس API تلقی میشود که در قسمت پیش نیازهای اتوماسیون به ریز شرح داده شده است. | |
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}}
JSONAPI Url از طریق پنل کاربری قابل مشاهده خواهد بود.
مقادیر ارسالی – Request Data #
عنوان | نوع | وضعیت | مقادیر | توضیحات |
main_id | Integer | اجباری | عطف چارتر | |
items | Array | تعداد آیتم های این فیلد متناسب با چارتر های انتخابی افزایش میابد | ||
items[index].id | Integer | اجباری | آیدی کلاس چارتر | |
items[index].lock_id | Integer | اجباری | آیدی قفل رزرو | |
items[index].local_pnr | String | اجباری | pnr داخلی | |
items[index].amount | Integer | اجباری | مجموع قیمت | |
items[index].passengers | Array | |||
items[index].passengers[index].gender | String | اجباری | male/female | |
items[index].passengers[index].fullname | ||||
items[index].passengers[index].fullname.first_name | ||||
items[index].passengers[index].fullname.first_name.en | String | اجباری | نام مسافر به صورت لاتین | |
items[index].passengers[index].fullname.first_name.fa | String | اجباری | نام مسافر به صورت فارسی | |
items[index].passengers[index].fullname.last_name | ||||
items[index].passengers[index].fullname.last_name.en | String | اجباری | نام خانوادگی مسافر به صورت لاتین | |
items[index].passengers[index].fullname.last_name.fa | String | اجباری | نام خانوادگی مسافر به صورت فارسی | |
items[index].passengers[index].identity | ||||
items[index].passengers[index].identity.nationality | String | اجباری | ||
items[index].passengers[index].identity.id | String | اجباری | ||
items[index].passengers[index].passport | ||||
items[index].passengers[index].passport.id | String | اجباری | ||
items[index].passengers[index].passport.expire_at | String | اجباری | ||
items[index].passengers[index].birth | String | اجباری | ||
items[index].passengers[index].mobile | String | اجباری | ||
items[index].passengers[index].email | String | اجباری |
{
"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
},
...
]
},
...
]
}
JSONپاسخ صحیح – Response True #
جواب این api به صورت آرایه میباشد
عنوان | نوع | مقادیر | توضیحات |
items | Array | ||
items[index].status | Boolean | true/false | هنگام رزرو یک چارتر با موفقیت مقدار این کلید true خواهد بود و در صورت بروز ارور این کلید false خواهد شد و مثل رویه های قبلی برای مشاهده دلیل ارور با توجه به error code به صفحه error handling مراجعه فرمایید. |
items[index].pnr | |||
items[index].pnr.local | String | pnr داخلی | |
items[index].pnr.original | String | pnr اصلی | |
items[index].pnr.id | Integer | شماره بلیت | |
items[index].item_id | Integer | هنگامی که کلید status برابر با false باشد این کلید وجود خواهد داشت. | |
items[index].code | Integer | شماره خطا مربوطه | هنگامی که کلید status برابر با false باشد این کلید وجود خواهد داشت که باید جهت استعلام خطا میتوانید از طریق این لینک اقدام کنید. |
meta | |||
meta.timestamp | Timestamp | زمان تولید پاسخ | این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود. |
{
"items": [
{
"status": true,
"pnr": {
"local": "D0Efs213",
"original": "htLQgDxD",
"id": 10013
}
},
{
"status": false,
"item_id": 10001,
"code": 1006
},
...
],
"meta": {
"timestamp": "Timestamp" // Timestamp
}
}
JSONپاسخ نادرست – Response False #
عنوان | نوع | مقادیر | توضیحات |
error | |||
error.code | Integer | شماره خطا مربوطه | جهت استعلام خطا میتوانید از طریق این لینک اقدام کنید. |
meta | |||
meta.timestamp | Timestamp | زمان تولید پاسخ | این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود. |
{
"error": {
"code":"Error Code"
},
"meta": {
"timestamp": "Timestamp" // Timestamp
}
}
JSONدر صورت مشاهده Status Code 404 URL درخواست خود را به اشتباه وارد نمود اید.