View Categories

خرید آیتم جستجو شده – Book

مدت زمان تخمینی مطالعه : 2 حداقل زمان مطالعه

این 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}}
JSON

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
        },
        ...
      ]
    },
    ...
  ]
}
JSON

پاسخ صحیح – Response True #

جواب این api به صورت آرایه میباشد

عنواننوعمقادیرتوضیحات
itemsArray
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 باشد این کلید وجود خواهد داشت که باید جهت استعلام خطا میتوانید از طریق این لینک اقدام کنید.
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    
    }
}
JSON

پاسخ نادرست – Response False #

عنواننوعمقادیرتوضیحات
error
error.codeIntegerشماره خطا مربوطهجهت استعلام خطا میتوانید از طریق این لینک اقدام کنید.
meta
meta.timestampTimestamp  زمان تولید پاسخ  این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود.
{
  "error": {
    "code":"Error Code"
  },
  "meta": {
    "timestamp": "Timestamp" // Timestamp
  }
}
JSON

در صورت مشاهده Status Code 404 URL درخواست خود را به اشتباه وارد نمود اید.

به‌روزرسانی در بهمن 1, 1403
Shopping Basket
خانه
وبلاگ
جست‌وجو
درخواست