مستندات

جست‌وجو در مستندات

نام اندپوینت، موضوع یا کلیدواژه را بنویسید

جست‌وجوی مکان هتل

مقصدی را که مسافر تایپ می‌کند به شناسه‌ای تبدیل کنید که با آن بتوانید هتل جست‌وجو کنید.

جست‌وجو و بازیابی مکان عمومی هستند و به نشست نیاز ندارند. از جست‌وجو برای کادر تکمیل خودکار (type-ahead) و از بازیابی (lookup) برای تبدیل دوبارهٔ شناسه‌هایی که قبلاً ذخیره کرده‌اید استفاده کنید.

جست‌وجوی مکان‌ها#

GET/v2/Hotel/cities/search

دسترسی عمومی، بدون نشست

متنی را که کاربر تایپ کرده در q بفرستید. مکان‌هایی با external_id دریافت می‌کنید. این شناسه را به‌عنوان CityId به جست‌وجوی ظرفیت بدهید.

پارامترهای کوئری#

نامنوعالزامیپیش‌فرضتوضیح
qstringاختیاری-متن کاربر، حداکثر ۱۲۸ نویسه. اگر خالی باشد فهرست خالی برمی‌گردد.
limitintegerاختیاری20حداکثر تعداد نتایج، از ۱ تا ۱۰۰.
typestringاختیاری-محدود کردن به یک نوع: city، district، region، country، landmark، hotel.
curl "https://api.simorghapi.com/api/v2/Hotel/cities/search?q=paris&limit=20&type=city"
const res = await fetch("https://api.simorghapi.com/api/v2/Hotel/cities/search?q=paris&limit=20&type=city");
const data = await res.json();
import requests

res = requests.get(
    "https://api.simorghapi.com/api/v2/Hotel/cities/search",
    params={"q": "paris", "limit": 20, "type": "city"},
)

data = res.json()

پاسخ#

فیلدنوعتوضیح
dataarray of objectمکان‌های منطبق. جزئیات در ادامه.
metaobjectquery، count، limit، type.
data[] object
فیلدنوعتوضیح
external_idstringشناسه‌ای که به‌عنوان CityId می‌فرستید (یا برای هتل، به‌عنوان HotelId).
typestringنوع مکان.
namestringنام کوتاه.
labelstringبرچسب کامل همراه با منطقه و کشور.
destinationstringرشتهٔ نمایشی مقصد.
countryobject{ "code", "name" }.
nr_hotelsintegerتعداد هتل‌های این مکان.
{
  "data": [
    {
      "id": 13,
      "external_id": "11111111456928",
      "type": "city",
      "name": "Paris",
      "label": "Paris, Ile de France, France",
      "destination": "Paris, Ile de France, France",
      "country": { "code": "FR", "name": "France" },
      "nr_hotels": 25708
    }
  ],
  "meta": { "query": "paris", "count": 1, "limit": 20, "type": "city" }
}

بازیابی شناسه‌های ذخیره‌شده#

POST/v2/Hotel/cities/lookup

دسترسی عمومی، بدون نشست

شناسه‌هایی را که ذخیره کرده‌اید دوباره به مکان تبدیل کنید. آرایه‌ای از external_ids بفرستید؛ برای هر شناسه یک شیء مکان برمی‌گردد.

POST /api/v2/Hotel/cities/lookup
{ "external_ids": ["11111111456928", "7825691"] }
قدم بعدی. external_id مکان انتخاب‌شده را بردارید و با API رزرو هتل هتل‌ها را جست‌وجو کنید.
ویرایش این صفحه در گیت‌هابمشکلی دیدید؟ از پنل ← پشتیبانی خبرمان کنید.