جست‌وجو
شروع به تایپ کنید و محتوای مورد نظر را جستجو کنید

برگه: سئوالات متداول

برای جستجو در موضوعات این بخش از کادر زیر استفاده نمایید

راهنمای بخش ها
راهنمای سامانه ها
راهنمای ابزارها + ویژگی ها
راهنمای پروفایل ها
راهنمای حساب + پنل کاربری
مفاهیم و آموزش های پایه
آموزش مفاهیم و روش های تحلیلی
آموزش روش ها و مفاهیم معاملاتی
روش ها و مفاهیم پرداخت ارزی
شاخص بان
مارکت بان
پرشین ای پی آی
سامانه معاملات طلا
راهنمای اپلیکیشن قیمت‌ها

وب سرویس ها

چطور می توانم به OpenAPI دست پیدا کنم؟
دسترسی به OpenAPI پرشین ای پی آی:
  1. به وب‌سایت پرشین ای پی آی مراجعه کنید: بر روی پلاتفرم ها و سپس Open API کلیک کنید مستندات OpenAPI یا لینک دسترسی به آن‌ها در این بخش‌ها قرار دارد.
  2.  Swagger UI:  رابط کاربری تعاملی API وجود دارد که به شما امکان می‌دهد نقاط پایانی API را بررسی، پارامترها را وارد و درخواست‌ها را ارسال کنید.
نحوه کار با Swagger به چه شکلی می باشد؟
نحوه کار با Swagger به شکل زیر می‌باشد:

  1. دسترسی به رابط کاربری Swagger UI:

    • ز طریق یک آدرس URL اختصاصی (مانند [آدرس API]/swagger-ui/) به رابط کاربری Swagger UI دسترسی پیدا می‌کنید. این آدرس توسط پرشین ای پی آی در اختیار شما قرار می‌گیرد.
    • با باز کردن این URL در مرورگر خود، یک صفحه وب تعاملی را مشاهده خواهید کرد.

  2. مشاهده نقاط پایانی (Endpoints):

    • در رابط کاربری Swagger UI، لیستی از نقاط پایانی API (URLهای مختلفی که API ارائه می‌دهد) بر اساس دسته‌بندی (مثلاً بر اساس منبع یا عملکرد) در کنار صفحه یا به صورت دسته‌های باز/بسته نمایش داده می‌شود.
    • با کلیک بر روی هر دسته یا نقطه پایانی، جزئیات مربوط به آن باز می‌شود.

  3. بررسی جزئیات یک نقطه پایانی:

    • هنگامی که یک نقطه پایانی را باز می‌کنید، اطلاعات زیر را مشاهده خواهید کرد:
      • HTTP Method: (GET، POST، PUT، DELETE و غیره) نوع درخواست مورد نیاز برای تعامل با این نقطه پایانی.
      • URL Path: آدرس دقیق این نقطه پایانی.
      • Summary و Description: توضیح مختصری و شرح مفصل درباره عملکرد این نقطه پایانی.
      • Parameters: پارامترهای مورد نیاز برای ارسال درخواست. این شامل:
        • Path Parameters: پارامترهایی که در خود URL قرار می‌گیرند (مثلاً /users/{id}).
        • Query Parameters: پارامترهایی که بعد از علامت ? در URL می‌آیند (مثلاً /users?page=1).
        • Header Parameters: پارامترهایی که در بخش Header درخواست HTTP ارسال می‌شوند (مثلاً Authorization).
        • Request Body: برای متدهایی مانند POST و PUT، ساختار داده‌ای که باید در بدنه درخواست ارسال شود (معمولاً به فرمت JSON).
      • Responses: پاسخ‌های احتمالی که API می‌تواند برگرداند، همراه با کدهای وضعیت HTTP (مانند ۲۰۰ OK، ۴۰۰ Bad Request، ۵۰۰ Internal Server Error) و ساختار بدنه پاسخ (به فرمت JSON).
      • Security: مکانیزم‌های احراز هویت مورد نیاز برای دسترسی به این نقطه پایانی.

  4. تلاش برای ارسال درخواست (Try it out):

    • رابط‌های کاربری Swagger UI دکمه‌ای با عنوان “Try it out“ یا مشابه آن را برای هر نقطه پایانی ارائه می‌دهند.
    • با کلیک بر روی این دکمه، فیلدهای ورودی برای پارامترهای مختلف فعال می‌شوند.

  5. وارد کردن مقادیر پارامترها:

    • مقادیر مورد نظر خود را در فیلدهای مربوط به پارامترهای Path، Query و Header وارد کنید.
    • اگر نقطه پایانی نیاز به Request Body دارد، یک نمونه ساختار JSON در اختیار شما قرار می‌گیرد که می‌توانید آن را با داده‌های مورد نظر خود ویرایش کنید.

  6. اجرای درخواست (Execute):

    • پس از وارد کردن تمام پارامترهای مورد نیاز، روی دکمه‌ “Execute“  کلیک کنید.
    • Swagger UI یک درخواست HTTP به API ارسال می‌کند.

  7. مشاهده پاسخ:

    • پس از دریافت پاسخ از API، Swagger UI آن را در بخش “Responses“ نمایش می‌دهد. این شامل:
      • Code: کد وضعیت HTTP پاسخ.
      • Headers: هدرهای پاسخ HTTP.
      • Body: بدنه پاسخ (معمولاً به فرمت JSON).
      • Response Schema: ساختار داده‌ای که در بدنه پاسخ انتظار می‌رود.

  8. بررسی مثال‌ها و اسکیماها:

    • Swagger UI مثال‌هایی از ساختار درخواست و پاسخ برای هر نقطه پایانی ارائه می‌دهد.
    • همچنین، شما می‌توانید اسکیما (Schema) یا ساختار داده‌ای مورد انتظار برای درخواست و پاسخ را مشاهده کنید تا نوع داده‌ها و فرمت آن‌ها را درک کنید.

به طور خلاصه، کار با Swagger UI شامل مراحل زیر است: دسترسی، مشاهده نقاط پایانی، بررسی جزئیات، وارد کردن پارامترها، اجرای درخواست و بررسی پاسخ. این ابزار به شما کمک می‌کند تا API را درک کنید، نحوه استفاده از آن را یاد بگیرید و آن را بدون نیاز به نوشتن کد تست کنید.

نحوه دسترسی به Swagger چگونه است ؟

به روش های زیر می توان به Swagger دسترسی پیدا کرد:

  1. از طریق آدرس URL اختصاصی:پرشین ای پی آی یک آدرس وب (URL) خاص برای رابط کاربری Swagger UI منتشر می کند. این آدرس مرتبط با آدرس پایه API است و می‌تواند به یکی از اشکال زیر باشد:
    • [آدرس پایه API]/swagger/
    • [آدرس پایه API]/api-docs/
    • [آدرس پایه API]/docs/
    • [آدرس پایه API]/swagger-ui/

    این آدرس را در مرورگر خود وارد کرده و به رابط کاربری تعاملی Swagger UI دسترسی پیدا کنید.

  2. از طریق لینک در وب‌سایت ارائه‌دهنده: پرشین ای پی آی لینکی به مستندات API در بخش‌های مختلف مانند “Developers”، “API Documentation”، “Resources” یا موارد مشابه قرار داده.  بر روی آن کلیک کند.
  3. از طریق پورتال توسعه‌دهندگان: یک پورتال اختصاصی برای توسعه‌دهندگان ارائه می شودشامل مستندات API، نمونه کدها، آموزش‌ها و ابزارهای مختلف است. مستندات Swagger UI در این پورتال در دسترس است.
  4. دریافت فایل OpenAPI Specification (JSON یا YAML): پرشین ای پی آی فایل OpenAPI Specification (با پسوند .json یا .yaml) را در اختیار مشتری قرار دهد. مشتری می‌تواند این فایل را در یک ابزار Swagger UI محلی یا آنلاین (مانند ادیتور آنلاین Swagger) بارگذاری کند تا مستندات API را مشاهده و تست کند.
Swagger چیست؟
Swagger UI (که اکنون به عنوان OpenAPI Specification شناخته می‌شود)، مجموعه‌ای از ابزارها و یک استاندارد باز برای توصیف، تولید، مصرف و تجسم سرویس‌های RESTful API است. به عبارت ساده‌تر، Swagger به توسعه‌دهندگان کمک می‌کند تا APIهای خود را به گونه‌ای مستند کنند که هم برای انسان و هم برای ماشین قابل فهم باشد.

در واقع، Swagger شامل موارد زیر است:

  • OpenAPI Specification (OAS): یک فرمت استاندارد برای توصیف رابط‌های API. این فرمت ساختار درخواست‌ها، پاسخ‌ها، پارامترها، مدل‌های داده، احراز هویت و سایر جنبه‌های API را به صورت JSON یا YAML تعریف می‌کند.
  • Swagger UI: یک ابزار تحت وب که مستندات OpenAPI را به صورت تعاملی نمایش می‌دهد. توسعه‌دهندگان و کاربران API می‌توانند از طریق این رابط کاربری، نقاط پایانی API را مشاهده، پارامترها را وارد کرده و درخواست‌ها را ارسال کنند و پاسخ‌ها را در مرورگر ببینند. این امر درک و تست API را بسیار آسان می‌کند.
  • Swagger Editor: یک ویرایشگر تحت وب برای ایجاد و ویرایش فایل‌های OpenAPI Specification. این ابزار به توسعه‌دهندگان کمک می‌کند تا مستندات API خود را به صورت بصری و با قابلیت اعتبارسنجی در لحظه ایجاد کنند.
  • Swagger Codegen (اکنون OpenAPI Generator): ابزاری که می‌تواند بر اساس فایل OpenAPI Specification، کدهای کلاینت (SDK) برای زبان‌های برنامه‌نویسی مختلف و همچنین کدهای سرور (Stubs) را تولید کند. این امر فرآیند یکپارچه‌سازی API را تسریع می‌بخشد.

مزایای استفاده از Swagger:

  • مستندسازی خودکار و تعاملی: تولید مستندات API که همیشه به‌روز هستند و امکان تست مستقیم API را فراهم می‌کنند.
  • بهبود همکاری: ایجاد یک زبان مشترک برای تیم‌های توسعه، تست و مستندسازی API.
  • تولید کد خودکار: تسریع فرآیند توسعه با تولید کدهای کلاینت و سرور.
  • کشف‌پذیری API: کمک به کاربران برای یافتن و درک نحوه استفاده از API.
  • تست آسان‌تر API: فراهم کردن یک رابط کاربری برای تست نقاط پایانی API بدون نیاز به ابزارهای جداگانه.

به طور خلاصه، Swagger (OpenAPI) یک ابزار قدرتمند برای مدیریت چرخه حیات API است که با ارائه یک استاندارد برای توصیف APIها، فرآیند توسعه، مستندسازی، و مصرف آن‌ها را بهبود می‌بخشد. پرشین ای پی آی از Swagger برای مستندسازی وب سرویس‌های خود استفاده می‌کند.

چطور می توانم دموی داده های وب سرویس را مشاهده نمایم؟

در پنل بالایی وب‌سایت روی بخش “دموها” کلیک کنید

با ورود به بخش “دموها”، بازار مورد نظر خود را از بالای صفحه انتخاب کنید. لیستی از وب سرویس‌های مختلف را مشاهده خواهید کرد.وب سرویس مورد نظر خود را انتخاب کنید. داده‌ها در همان صفحه نمایش داده می شوند. می توانید فیلترهای مختلفی را اعمال کنید

از چه پلتفرم هایی برای پیاده سازی و داکیومنت وب سرویس ها استفاده شده است؟
 برای پیاده‌سازی وب سرویس‌ها از زبان‌ PHP و فریم‌ورک‌ لاراول و برای مستندسازی از ابزارهایی مانند Swagger، و OpenAPI استفاده می‌شود.
چطور می توانم محصولات هر دسته از وب سرویس ها را مشاهده نمایم؟
ابتدا روی گزینه “وب سرویس ها” کلیک کنید. سپس در صفحه وب سرویس ها، به دنبال بخش هایی با عناوین مشابه دسته بندی های زیر بگردید و روی هر کدام کلیک کنید تا به محصولات آن دسته دسترسی پیدا کنید:
  1. وب سرویس های پایه: در این بخش، می توانید محصولات و جزئیات مربوط به پکیج پایه که شامل داده های لحظه ای از بازارهای مختلف است را مشاهده کنید.
  2. وب سرویس های بازار داخلی: این بخش شامل لیست وب سرویس های مربوط به داده ها و نرخ های بازارهای مالی و اقتصادی داخل ایران است.
  3. وب سرویس های بازار جهانی: در این قسمت، می توانید وب سرویس های مربوط به داده ها و نرخ های بازارهای مالی و اقتصادی بین المللی را مشاهده کنید.
  4. وب سرویس های اقتصاد کشورها: این بخش شامل وب سرویس های ارائه دهنده داده ها و پیش بینی های مربوط به اقتصاد کشورهای مختلف است.
  5. وب سرویس های بازار بورس: در این قسمت، می توانید لیست وب سرویس های تخصصی داده ها و اطلاعات بازار بورس اوراق بهادار را مشاهده کنید.
  6. وب سرویس های بازار خرده فروشی: این بخش شامل وب سرویس های ارائه دهنده داده ها و آمارهای مربوط به قیمت ها و تحرکات در بخش های مختلف بازار خرده فروشی ایران است.
  7. وب سرویس های اختصاصی: در این قسمت، اطلاعات مربوط به نحوه سفارش سرویس های تامین داده سفارشی و تخصصی ارائه شده است.
وب سرویس ها شامل چند دسته می باشند و هر دسته چه داده هایی را پوشش می دهد؟
وب سرویس های پرشین ای پی آی شامل هفت دسته اصلی می باشند که  داده های زیر را پوشش می دهند:

  1. وب سرویس های پایه: داده‌های لحظه‌ای و جامع از بازارهای مختلف از جمله ارز (آزاد، بانکی، سنا)، فلزات گرانبها (طلا، نقره، پلاتین، پالادیوم)، بازار طلا (آبشده، عیارهای مختلف)، بازار سکه (انواع سکه)، بازار بورس (شاخص‌های داخلی)، بازار نفت (نفت خام، گاز طبیعی) و برابری ارزها در برابر دلار آمریکا.

  2. وب سرویس های بازار داخلی: داده‌ها و نرخ‌های مربوط به بازارهای مالی و اقتصادی داخل ایران شامل بازار داخلی به صورت جامع، بازار طلا، قیمت آبشده، بازار سکه، قیمت سکه، بازار ارز و قیمت دلار.

  3. وب سرویس های بازار جهانی: داده‌ها و نرخ‌های مربوط به بازارهای مالی و اقتصادی بین‌المللی شامل بازار جهانی به صورت جامع، بازار فلزات پایه، بازار فلزات گران‌بها، بازار نفت و انرژی، بازارهای کالایی، بازار ارزهای دیجیتال، بازار فارکس، بازارهای ارزی کشورها، شاخص‌ بورس کشورها، بازارهای سهام کشورها، بازار اوراق قرضه کشورها و صندوق‌‌های سرمایه‌گذاری بین‌المللی.

  4. وب سرویس های اقتصاد کشورها: داده‌ها و پیش‌بینی‌های مربوط به اقتصاد کشورهای مختلف جهان شامل شاخص‌های اقتصادی، پیش‌بینی شاخص‌های اقتصادی، اقتصاد کشورها به صورت جامع، پیش‌بینی اقتصاد کشورها، پیش‌بینی بازار اوراق قرضه، پیش‌بینی بازار کالاها، پیش‌بینی بازارهای ارزی و پیش‌بینی بازارهای سهام.

  5. وب سرویس های بازار بورس: داده‌ها و اطلاعات مربوط به بازار بورس اوراق بهادار شامل شاخص‌های بورس، سهام، اوراق، نمادهای بسته شده، صندوق‌های سرمایه‌گذاری بورسی، آتی، اوراق تسهیلات مسکن، آپشن، حق تقدم، قیمت پایانی، نوسان قیمت، تعداد معاملات، ارزش بازار، ارزش روز دارایی‌ها، حقوق صاحبان سهم و بدهی ها.

  6. وب سرویس های بازار خرده فروشی: داده‌ها و آمارهای مربوط به قیمت‌ها و تحرکات در بخش‌های مختلف بازار خرده فروشی ایران شامل بازار خودرو، بازار مواد غذایی، بازار آهن آلات، بازار شبکه و کامپیوتر، بازار کالاهای دیجیتال، بازار ابزارآلات، بازار لوازم خانگی، بازار کاغذ و مقوا، بازار زیبایی و سلامت، بازار لوازم کودک و نوزاد، بازار پوشاک، بازار ورزش و سرگرمی، بازار محصولات فرهنگی و بازار مصالح ساختمانی.

  7. وب سرویس های اختصاصی: تامین هر نوع داده، محتوا یا اطلاعات تخصصی از انواع منابع اعم از سایت ها یا منابع جهانی، API یا وب سرویس های اشتراکی، منابع پیچیده و تحت لاگین یا محتویاتی دارای لایه های متعدد حفاظتی، در فرمت مورد نظر مشتری.

آیا امکان دریافت نمودارها هم از طریق وب سرویس وجود دارد؟
خیر، این امکان در حال حاضر میسر نیست.
“کد نمایش قیمت‌ها” چیست و چه کارکردی دارد؟

“کد نمایش قیمت ها” ابزاری است که قطعه کد نمایش جداول در سایر سامانه ها و وب سایت ها را بدون نیاز به دانش برنامه نویسی و با چند تنظیم ساده تولید می نماید و آن دسته از مدیران وب سایت ها را که فاقد دانش تخصصی برنامه نویسی یا گروه فنی برای انجام این کار می باشند قادر می سازد تا در ظرف چند دقیقه و به ساده ترین شیوه ممکن، قطعه کد مورد نظر برای نمایش نرخ های موردنظرشان را بدست بیاورند و پس از این کافیست که کد مذکور در بلوک یا محل مورد نظر در وب سایت مقصد کپی گردد تا نتیجه مورد نظر حاصل شود.

 

از اصلی ترین ویژگی های این ابزار می توان به این موارد اشاره کرد:

 

  • امکان انتخاب شاخص های مورد نظر نظیر طلا، سکه، دلار و ….
  • امکان تنظیم و چیدمان ستون های جداول و دیتاها
  • امکان تنظیم رنگ پس زمینه سرتیتر، رنگ متن سرتیتر، رنگ بوردرها و سایر تنظیمات ظاهری
  • امکان استفاده تفکیکی از شاخص ها در قالب دسته بندی های مختلف به شکل همزمان
  • سادگی، وضوح، سهولت و سرعت فرآیند استفاده
صفحه نخست
تبلیغات
وب سرویس
سامانه پشتیبانی
سامانه مشاغل
مفاهیم و اصطلاحات
قوانین

هر گونه کپی برداری از محتوا، تولیدات، شکل و سایر اجزای سایت صرفا با موافقت مکتوب مجاز می باشد

تماس با ما