برای استفاده از وب سرویس های وب سایت برج آزادی، لازم است تا ابتدا یک token جهت اعتبار سنجی دریافت کنید. (برای دریافت token به صفحه درخواست وب سرویس مراجعه بفرمایید)
پس از دریافت توکن، لازم است در همه درخواست های ارسالی، دو header به صورت زیر ارسال کنید.
token: [YOUR_TOKEN]
language: farsi | english | arabic
method همه درخواست های ارسالی post است.
شرح وب سرویس های مورد نیاز در فرآیند خرید بلیط در ادامه آمده است. برای دریافت خروجی postman اینجا کلیک کنید.
پیشنهاد می‌شود برای مشاهده یک نمونه واقعی، به صفحه خرید بلیط وب سایت برج آزادی مراجعه بفرمایید.
دریافت اطلاعات اولیه
برای دریافت مقادیر مورد نیاز فرم قبل از لیست بلیط ها (شامل گروه ها، سانس ها و ملیت ها)، از این متد استفاده کنید.
این متد هیچ مقدار ورودی ندارد و در خروجی لیستی از اطلاعات را در قالب Json ارائه می‌کند.
Url: https://azadi-tower.ir/api/get_information
دریافت بلیط ها
برای دریافت بلیط ها لازم است تا مقادیر زیر را به این Url ارسال کنید::
Url: https://azadi-tower.ir/api/get_tickets
مقادیر ورودی
| فیلد | الزامی | مثال | توضیحات | |
|---|---|---|---|---|
| 1 | date | بله | 1402/5/29 | تاریخ بازدید به شمسی |
| 2 | hour | بله؛ برای خرید گروهی | شناسه سانس | |
| 3 | group | بله؛ برای خرید گروهی | indivisual | نوع گروه (برای بازدید های انفرادی indivisual باشد.) |
| 4 | count | بله | 2 | تعداد نفر |
| 5 | nation | بله | iranian | ملیت (ایرانی یا غیرایرانی) |
مقادیر خروجی
خروجی این وب سرویس شامل لیست بلیط های (در صورت وجود) است که شناسه، عنوان، تصویر، قیمت و توضیحات هر بلیط در آن آمده است.
خرید بلیط
برای دریافت بلیط ها لازم است تا مقادیر زیر را به این Url ارسال کنید::
Url: https://azadi-tower.ir/api/set_ticket
مقادیر ورودی
| فیلد | الزامی | مثال | توضیحات | |
|---|---|---|---|---|
| 1 | date | بله | 1402/5/29 | تاریخ بازدید به شمسی |
| 2 | hour | بله؛ برای خرید گروهی | شناسه سانس | |
| 3 | group | بله؛ برای خرید گروهی | indivisual | نوع گروه (برای بازدید های انفرادی indivisual باشد.) |
| 4 | count | بله | 2 | تعداد نفر |
| 5 | nation | بله | iranian | ملیت (ایرانی یا غیرایرانی) |
| 6 | organ_title | بله؛ برای خرید گروهی | نام مجموعه (برای خرید های گروهی) | |
| 7 | first_name | بله | حسین | نام خریدار |
| 8 | last_name | بله | علیزاده | نام خانوادگی خریدار |
| 9 | mobile | بله | 09122222222 | موبایل خریدار |
| 10 | خیر | ایمیل خریدار | ||
| 11 | ticket_ids | بله | 1,2 | شناسه بلیط های خریداری شده |
مقادیر خروجی
خروجی این وب سرویس شامل یک کد خرید می‌باشد که برای بازدید از برج آزادی باید ارائه شود.
کالکشن postman وب سرویس خرید بلیط برج آزادی به صورت عموم در فضای مستندات postman قرار داده شده و می توانید برای دسترسی به آن اینجا کلیک کنید.
کدهای خطا
در ادامه لیست کدهای پاسخ به همراه توضیحات هر کدام آمده است.
| کد | توضیحات |
|---|---|
| 200 | درخواست با موفقیت انجام شد. |
| 301 | مطابق درخواست شما بلیطی یافت نشد. |
| 302 | درخواست ارسالی نامعتبر است. |
| 303 | تاریخ نامعتبر است. |
| 304 | ساعت نامعتبر است. |
| 305 | تعداد (نفر) نامعتبر است. |
| 306 | گروه نامعتبر است. |
| 307 | ملیت نامعتبر است. |
| 308 | نام مجموعه نامعتبر است. |
| 309 | نام کاربر نامعتبر است |
| 310 | موبایل کاربر نامعتبر است. |
| 311 | شناسه بلیط (ها) نامعتبر است. |
| 401 | توکن نامعتبر است. |
| 402 | موجودی حساب کافی نیست. |
| 403 | آدرس IP نامعتبر است. |
| 404 | زبان ارسالی نامعتبر است. |
