جهت استفاده از وب سرویس ها مراحل زیر باید سپری شود : 

• مراجعه به پرشین ای پی آی
  

• مراجعه به بخش وب سرویس‌ها
  

• گزینش بسته مورد نظر

• ​خرید سرویس مورد نظر

• ​دریافت توکن و راهنمای استفاده

• ​تهیه یا تولید کد مورد نیاز جهت استفاده از اطلاعات وب سرویس

• ​تست و استفاده از وب سرویس خریداری شده   

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

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

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

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

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

در روش “کد نمایش قیمت ها” امضای سایت در زیر کلیه جداول وجود دارد ولی در روش وب سرویس، هیچ نشانه ای از منبع اصلی قیمت ها وجود ندارد.

در روش وب سرویس، کلیه نوسانات به شکل لحظه ای و همزمان با وب سایت مبدا در مقصد نیز نمایش داده می شود و این امتیاز در روش “کد نمایش قیمت ها” به این شیوه وجود ندارد.

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

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

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

برای پیاده‌سازی وب سرویس‌ها از زبان‌ PHP و فریم‌ورک‌ لاراول و برای مستندسازی از ابزارهایی مانند Swagger، و OpenAPI استفاده می‌شود.

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

۱. از طریق آدرس URL اختصاصی:پرشین ای پی آی یک آدرس وب (URL) خاص برای رابط کاربری Swagger UI منتشر می کند. این آدرس مرتبط با آدرس پایه API است و می‌تواند به یکی از اشکال زیر باشد:

[آدرس پایه API]/swagger/

[آدرس پایه API]/api-docs/

[آدرس پایه API]/docs/

[آدرس پایه API]/swagger-ui/این آدرس را در مرورگر خود وارد کرده و به رابط کاربری تعاملی Swagger UI دسترسی پیدا کنید.

۲. از طریق لینک در وب‌سایت ارائه‌دهنده: پرشین ای پی آی لینکی به مستندات API در بخش‌های مختلف مانند “Developers”، “API Documentation”، “Resources” یا موارد مشابه قرار داده.  بر روی آن کلیک کند.

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

۴. دریافت فایل OpenAPI Specification (JSON یا YAML): پرشین ای پی آی فایل OpenAPI Specification (با پسوند .json یا .yaml) را در اختیار مشتری قرار دهد. مشتری می‌تواند این فایل را در یک ابزار Swagger UI محلی یا آنلاین (مانند ادیتور آنلاین Swagger) بارگذاری کند تا مستندات API را مشاهده و تست کند.

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

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

با باز کردن این URL در مرورگر خود، یک صفحه وب تعاملی را مشاهده خواهید کرد.

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

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

با کلیک بر روی هر دسته یا نقطه پایانی، جزئیات مربوط به آن باز می‌شود.

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

هنگامی که یک نقطه پایانی را باز می‌کنید، اطلاعات زیر را مشاهده خواهید کرد:

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: مکانیزم‌های احراز هویت مورد نیاز برای دسترسی به این نقطه پایانی.

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

رابط‌های کاربری Swagger UI دکمه‌ای با عنوان “Try it out” یا مشابه آن را برای هر نقطه پایانی ارائه می‌دهند.

با کلیک بر روی این دکمه، فیلدهای ورودی برای پارامترهای مختلف فعال می‌شوند.

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

مقادیر مورد نظر خود را در فیلدهای مربوط به پارامترهای Path، Query و Header وارد کنید.

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

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

پس از وارد کردن تمام پارامترهای مورد نیاز، روی دکمه‌”Execute”  کلیک کنید.

Swagger UI یک درخواست HTTP به API ارسال می‌کند.

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

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

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

Swagger UI مثال‌هایی از ساختار درخواست و پاسخ برای هر نقطه پایانی ارائه می‌دهد.

همچنین، شما می‌توانید اسکیما (Schema) یا ساختار داده‌ای مورد انتظار برای درخواست و پاسخ را مشاهده کنید تا نوع داده‌ها و فرمت آن‌ها را درک کنید.

OpenAPI (که قبلاً به عنوان Swagger شناخته می‌شد) یک استاندارد صنعتی برای توصیف رابط‌های برنامه‌نویسی کاربردی (APIs) به صورت قابل فهم برای ماشین و انسان است.

به زبان ساده، OpenAPI یک راه استاندارد برای توصیف این است که یک API چگونه کار می‌کند.که شامل موارد زیر است:

نقاط پایانی (Endpoints) موجود: چه آدرس‌های وب (URLها) برای دسترسی به عملکردهای مختلف API وجود دارد (مثلاً گرفتن اطلاعات یک محصول، ثبت سفارش و غیره).

عملیات (Operations) پشتیبانی شده: برای هر نقطه پایانی، چه نوع درخواست‌های HTTP (مانند GET، POST، PUT، DELETE) قابل استفاده است.

پارامترها: چه ورودی‌هایی (مانند شناسه محصول، کلید API) باید در درخواست‌ها ارسال شوند (در URL، بدنه درخواست، هدرها و غیره).

ساختار درخواست‌ها (Request Bodies): اگر درخواستی داده‌ای را به سرور ارسال می‌کند، ساختار آن داده (مثلاً فرمت JSON یا XML) چگونه است و چه فیلدهایی دارد.

ساختار پاسخ‌ها (Response Bodies): API در پاسخ به درخواست‌ها چه داده‌ای را برمی‌گرداند، ساختار آن چگونه است و چه فیلدهایی دارد. همچنین کدهای وضعیت HTTP (مانند ۲۰۰ برای موفقیت، ۴۰۰ برای خطای کاربر) نیز توصیف می‌شوند.

امنیت (Security): API از چه روش‌های احراز هویتی (مانند کلید API، OAuth 2.0) استفاده می‌کند.

​

مستندسازی خودکار: ابزارها می‌توانند به طور خودکار مستندات API تعاملی و قابل فهم برای توسعه‌دهندگان را از فایل‌های OpenAPI تولید کنند (مانند Swagger UI).

تولید کد: ابزارها می‌توانند کدهای کلاینت (برای زبان‌های برنامه‌نویسی مختلف) و حتی کدهای سرور را بر اساس فایل OpenAPI تولید کنند، که فرآیند ادغام با API را بسیار سریع‌تر و آسان‌تر می‌کند.

تست API: ابزارهای تست API می‌توانند از فایل‌های OpenAPI برای پیکربندی و اجرای تست‌های خودکار استفاده کنند.

بهبود همکاری: یک توصیف استاندارد به تیم‌های مختلف (توسعه‌دهندگان بک‌اند، فرانت‌اند، مستندسازان) کمک می‌کند تا درک یکسانی از API داشته باشند.

کشف‌پذیری API: استاندارد بودن OpenAPI به ابزارها و پلتفرم‌های مختلف اجازه می‌دهد تا APIها را بهتر کشف و با آن‌ها تعامل داشته باشند.

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

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

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

(XML (eXtensible Markup Language : زبان XML نوعی زبان نشانه گذاری قابل گسترش است. از این زبان به منظور انتقال اطلاعات به صورت متن در بین وب سرویس‌ها استفاده می‌شود.

(SOAP (Simple Object Access Protocol : روشی برای انتقال اطلاعات در وب سرویس‌ها است که از استانداردهای زیادی پیروی می‌کند. این پروتکل برای انتقال اطلاعات با سطح امنیتی بالا مناسب است و کاملا قابل اطمینان می‌باشد. پیاده سازی وب سرویس‌های مبتنی بر پروتکل SOAP از پیچیدگی بیشتری برخوردارند. استفاده از این پروتکل در سرویس‌های توزیع شده (distributed systems) کاربرد بیشتری دارد.

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

(UDDI (Universal Description, Discovery and Integration : این استاندارد امکان معرفی و ثبت وب سرویس‌ها را برای برنامه نویسان و شرکت‌ها فراهم می‌کند. این پروتکل یک فایل XML است که وب سرویس‌ها به منظور اتصال به یکدیگر از طریق آن تعیین مکان می‌شوند. به عبارتی دیگر UDDI فهرستی از وب سرویس‌ها است که در آن نوع و نحوه دسترسی آن‌ها مشخص شده است.