قفل، خرید و بررسی

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

این API به‌طور اختصاصی برای انجام عملیات رزرو چارتری طراحی شده است. از طریق این API تنها می‌توانید درخواست‌های رزرو جدید برای چارتری ارسال کنید و اطلاعات مربوط به رزرو انجام شده را دریافت نمایید.

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

رزرو از طریق API

عنوان وضعیت مقادیر توضیحات
Method اجباری POST متد ارسال درخواست
Domain اجباری نام دامنه ثبت شده در اتوماسیون  
Api Url اجباری دامنه هسته مرکزی سرویس  
Api version اجباری به نسخه فعلی سرویس API تلقی میشود که در قسمت پیش نیازهای اتوماسیون به ریز شرح داده شده است.  
Authorization اجباری توکن JWT تولید شده این توکن بصورت JWT تولید میشود.

در این روش شما باید درخواست خود را از طریق لینک زیر ارسال فرمائید.

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

سربرگ – 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 از طریق پنل کاربری قابل مشاهده خواهد بود.

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

مقادیر ارسالی – 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
        },
        ...
      ]
    },
    ...
  ]
}
خرید آیتم جستجو شده – Book

پاسخ صحیح – 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 می باشد – در صورت نیاز از این زمان استفاده شود.
دریافت این پاسخ با Status Code 200 دریافت خواهد شد.
{
    "items": [
        {
            "status": true,
            "pnr": {
                "local": "D0Efs213",
                "original": "htLQgDxD",
                "id": 10013
            }
        },
        {
            "status": false,
            "item_id": 10001,
            "code": 1006
        },
        ...
    ],
    "meta": {
      "timestamp": "Timestamp" // Timestamp    
    }
}
خرید آیتم جستجو شده – Book

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

عنوان نوع مقادیر توضیحات
error      
error.code Integer شماره خطا مربوطه جهت استعلام خطا میتوانید از طریق این لینک اقدام کنید.
meta      
meta.timestamp Timestamp   زمان تولید پاسخ

  این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود.

{
  "error": {
    "code":"Error Code"
  },
  "meta": {
    "timestamp": "Timestamp" // Timestamp
  }
}

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

آخرین وضعیت آیتم خریداری شده – Book Status

در این بخش میتوانید از وضعیت رزرو خود مطلع شوید.

آخرین وضعیت آیتم خریداری شده – Book Status

اطلاع از وضعیت رزرو از طریق API

عنوان وضعیت مقادیر توضیحات
Method اجباری GET متد ارسال درخواست
Domain اجباری نام دامنه ثبت شده در اتوماسیون  
Api Url اجباری دامنه هسته مرکزی سرویس  
Api version اجباری به نسخه فعلی سرویس API تلقی میشود که در قسمت پیش نیازهای اتوماسیون به ریز شرح داده شده است.  
Authorization اجباری توکن JWT تولید شده این توکن بصورت JWT تولید میشود.

در این روش شما باید درخواست خود را از طریق لینک زیر ارسال فرمائید.

آخرین وضعیت آیتم خریداری شده – Book Status

سربرگ – 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 از طریق پنل کاربری قابل مشاهده خواهد بود.

آخرین وضعیت آیتم خریداری شده – Book Status

مقادیر ارسالی – Request Data

عنوان نوع وضعیت مقادیر توضیحات
local_pnr String اجباری pnr داخلی
{
  "local_pnr": ""
}
آخرین وضعیت آیتم خریداری شده – Book Status

پاسخ صحیح – Response True

عنوان نوع مقادیر توضیحات
payload      
payload.status String confirmed/canceled/refund/done هنگام تایید مقدار کلید برابر با confirmed خواهد بود و هنگام کنسل شدن برابر با canceled خواهد بود و اگر استرداد شده بود برابر با refund و اگر پرواز انجام شده بود برابر با مقدار done خواهد بود.
payload.pnr      
payload.pnr.local String pnr داخلی  
payload.pnr.original String pnr اصلی  
payload.pnr.number Integer شماره بلیت  
payload.refund     اگر مقدار کلید payload.status برابر با refund بود این کلید وجود خواهد داشت.
payload.refund.id Integer    
meta      
meta.timestamp Timestamp   زمان تولید پاسخ   این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود.

دریافت این پاسخ با Status Code 200 دریافت خواهد شد.

{
    "payload": {
        "status": "refund",
        "pnr": {
            "local": "",
            "original": "",
            "number": 10011
        },
        "refund": {
            "id": 10007
        }
    },
    "meta": {
        "timestamp": "Timestamp" // Timestamp
    }
}

 

آخرین وضعیت آیتم خریداری شده – Book Status

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

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

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

قفل آیتم جستجو شده – Lock

در این بخش شما میتوانید آیتم جستجو شده ی خود را جهت رزرو قفل کنید.

قفل آیتم جستجو شده – Lock

قفل آیتم از طریق API

عنوان وضعیت مقادیر توضیحات
Method اجباری POST متد ارسال درخواست
Domain اجباری نام دامنه ثبت شده در اتوماسیون  
Api Url اجباری دامنه هسته مرکزی سرویس  
Api version اجباری به نسخه فعلی سرویس API تلقی میشود که در قسمت پیش نیازهای اتوماسیون به ریز شرح داده شده است.  
Authorization اجباری توکن JWT تولید شده این توکن بصورت JWT تولید میشود.

در این روش شما باید درخواست خود را از طریق لینک زیر ارسال فرمائید.

قفل آیتم جستجو شده – Lock

سربرگ – 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 از طریق پنل کاربری قابل مشاهده خواهد بود.

قفل آیتم جستجو شده – Lock

مقادیر ارسالی – Request Data

عنوان نوع وضعیت مقادیر توضیحات
charters Array اجباری   آیتم های این کلید متناسب با تعداد چارتر های انتخاب شده تغییر میکند.
charters[index].id Integer اجباری    
charters[index].item_id Integer اجباری    
charters[index].passengers        
charters[index].passengers.adult Integer اجباری    
charters[index].passengers.infant Integer اجباری

{
  "charters": [
    {
      "id": 10002,
      "item_id": 10005,
      "passengers": {
        "adult": 2,
        "infant": 1
      }
    },
    ...
  ]
}
قفل آیتم جستجو شده – Lock

پاسخ صحیح – Response True

عنوان نوع مقادیر توضیحات
items Array    
items[index].id Integer    
items[index].status Boolean true/false ممکن است مقدارش true باشد و ممکن است بعضی از ایتم ها قفل نشوند بنابراین مقدار این کلید در آن آیتم ها false خواهد بود.
items[index].lock_id Integer آیدی قفل رزرو هنگامی که کلید status true باشد این کلید وجود دارد
items[index].duration Integer مدت زمان قفل رزرو هنگامی که کلید status true باشد این کلید وجود دارد
items[index].expiration String زمان انقضای قفل رزرو هنگامی که کلید status true باشد این کلید وجود دارد
items[index].code Integer code error هنگامی که کلید status false باشد این کلید وجود دارد که مثل رویه های قبلی باید به صفحه error handling برای مشاهده دلیل ارور خود مراجعه فرمایید.
meta      
meta.timestamp Timestamp   زمان تولید پاسخ   این زمان بر اساس 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
    }
}

 

قفل آیتم جستجو شده – Lock

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

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

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

لغو قفل انجام شده – Unlock

در این بخش شما میتوانید قفل یک رزرو را که قبلا با استفاده از api lock انجام داده اید لغو کنید.

لغو قفل انجام شده – Unlock

لغو قفل آیتم از طریق API

عنوان وضعیت مقادیر توضیحات
Method اجباری POST متد ارسال درخواست
Domain اجباری نام دامنه ثبت شده در اتوماسیون  
Api Url اجباری دامنه هسته مرکزی سرویس  
Api version اجباری به نسخه فعلی سرویس API تلقی میشود که در قسمت پیش نیازهای اتوماسیون به ریز شرح داده شده است.  
Authorization اجباری توکن JWT تولید شده این توکن بصورت JWT تولید میشود.

در این روش شما باید درخواست خود را از طریق لینک زیر ارسال فرمائید.

لغو قفل انجام شده – Unlock

سربرگ – 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 از طریق پنل کاربری قابل مشاهده خواهد بود.

لغو قفل انجام شده – Unlock

مقادیر ارسالی – Request Data

عنوان نوع وضعیت مقادیر توضیحات
lock_id Integer اجباری آیدی قفل آیتم مربوطه
{
    "lock_id": 20021
}

هنگامی که فرآیند لغو قفل رزرو با موفقیت انجام شود status code درخواست برابر با 204 خواهد بود و جوابی برای این api وجود ندارد.

لغو قفل انجام شده – Unlock

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

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

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

لیست خریدها – Book History (بزودی)

لیست خریدها – Book History (بزودی)

بزودی…