راهنمای استفاده از API ها

آذر ۲۲, ۱۳۹۴

یکی از خدمات جذاب سایت MBaaS، ارائه APIهای REST متنوع به توسعه‌دهندگان است. با استفاده از این سرویس، دیگر نیاز به ایجاد زیرساخت اختصاصی جهت دریافت اطلاعات پرکاربردی مانند آخرین نرخ ارز، پیش‌بینی آب و هوا، لیست پروازها و … ندارید و تنها با داشتن یک API KEY، نام کاربری و کلمه عبور می‌توانید از خدمات این سایت استفاده نمائید.

جهت ارتباط با APIهای مختلف سایت MBaaS، می‌توانید از SDKهای مربوط به پلتفرم‌های مختلف که از لینک‌های زیر قابل دانلود هستند، استفاده نمائید.

به منظور استفاده از این APIها، ابتدا باید در سایت www.mbaas.ir ثبت‌نام کرده، سپس نام کاربری و کلمه‌عبور مربوط به کار با APIها را مشابه تصویر ذیل فعال نمائید.

enable_apiحال در صفحه APIها، با کلیک بر روی دکمه “مشاهده اطلاعات فنی” مربوط به API موردنظر خود، می‌توانید API Key و API Link را مشابه تصویر ذیل به دست آورید:

api_infoبا فعال‌سازی و داشتن API Key و API Link مربوط به API موردنظر خود، حال می‌توانید با استفاده از SDKهای فوق شروع به برنامه نویسی کنید.

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

http://files.mbaas.ir/examples/mbaas-api.zip

در نمونه کدی که دریافت خواهید کرد، در شاخه js، دو فایل مهم با نام‌های script.js و functions.js وجود دارند.

فایل script.js جهت راه‌اندازی برنامه و مقداردهی اولیه متغیرها استفاده می‌شود. متغیرهای INSTANCE_URL و APP_API_KEY مهمترین متغیرهایی هستند که مشابه ذیل مقداردهی شده‌اند و نیازی به تغییر مقدار آن‌ها نیست، اما در صورتیکه زیرساخت اختصاصی خود را دارید می‌توانید مقادیر را جایگزین نمائید.

var INSTANCE_URL = 'http://api.mbaas.ir';
var APP_API_KEY = 'b34967b4bbcad31413a25f0393988de73caa60a0537db2fb3041c834e1f6a158';

فایل function.js حاوی توابع مختلفی است که برای ثبت‌نام، ورود و غیره استفاده می‌شوند.

تابع callExRateAPI در فایل functions.js، جهت برقراری ارتباط با API نرخ ارز نوشته شده است. همانطور که مشاهده می‌نمائید، پارامتر url تابع $.ajax مشابه ذیل مقداردهی شده است:

url: INSTANCE_URL + '/api/v2/free/ExRate'

جهت فیلتر اطلاعات موردنظر خود نیز باید پارامتر data را مشابه زیر مقداردهی نمائید:

data: {"filter":"Currency='USD' or Currency='GBP'"}

به عنوان مثال با استفاده از فیلتر فوق، نرخ دلار و پوند از بین نرخ‌های موجود، دریافت خواهند شد. دقت کنید، فیلترها مشابه کوئری‌های MySQL نوشته شده‌اند.

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

api_loginدر این صفحه، باید ایمیل و کلمه‌عبوری که در سایت www.mbaas.ir فعال نموده‌اید را وارد کنید، تا به محض ورود، آخرین نرخ ارزها را مشابه تصویر زیر مشاهده نمائید:

exratesبه منظور راحتی توسعه‌دهندگان عزیز، سعی خواهد شد، طی روزهای آتی نمونه کد با زبان‌های دیگری مانند جاوا، .NET و … نوشته و لینک دانلود آن‌ها به ادامه این مطلب افزوده شود.

تگ‌ها ;

4 نظر

    reza فروردین ۲۹, ۱۳۹۵

    میشه درباره طریقه استفاده از ای پی آی های خودتون برای اندروید توضیحی بدید؟

    پاسخ دادن
      مهدی مرادی فروردین ۲۹, ۱۳۹۵

      سلام دوست عزیز

      حتما تا چند روز آینده یک مطلب در این مورد قرار خواهیم داد.

      پاسخ دادن
    محمد مرداد ۱۸, ۱۳۹۵

    سلام میشه نحوه استفاده api ها رو دات نت بگید..ممنون

    پاسخ دادن
      مهدی مرادی مرداد ۱۸, ۱۳۹۵

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

      پاسخ دادن

نظر دهید:

لطفا در نظر داشته باشید که بر اظهارنظرها نظارت می شود. بنابراین، در نظرات خود از کلمات اسپم و ... استفاده نکنید، در غیر این صورت نظر شما حذف خواهد شد.