راهنمای API مستر2اپ

از طریق api مستر۲اپ میتوانید سیستم ساخت آنلاین اپلیکیشن را بر روی بستر وب سایت خودتان پیاده سازی کنید.

مستر۲اپ توابعی را برای پیاده سازی این سیستم در اختیار شما قرار داده است.

متد‌های API

ساخت اپلیکیشن

  • نام متد : create_app
  • آدرس متد : ‌ http://mr2app.com/api/reseller/create_app
  • توضیحات : این متد جهت ثبت و ساخت اولین نسخه از اپلیکیشن استفاده میشود ٬ در خروجی این متد یک کلید اپ یا همان app_id ارسال میشود که جهت دریافت خروجی پس از آماده شدن آن در متد get_app لازم است.
  • ورودی‌ (JSON – POST)

    • username
      • توضیحات : نام کاربری یا ایمیل شما در سیستم مستر۲اپ
    • api_key
      • توضیحات : این کلید را باید از بخش پشتیبانی دریافت کنید.
    • pkg_name
      • توضیحات : پکیج نیم اپلیکیشن
    • app_type
      • توضیحات : نوع اپلیکیشن درخواست شده
      • مقادیر
        • ۱ : اپلیکیشن وردپرس
        • ۲ : اپلیکیشن ووکامرس
        • ۳ : اپلیکیشن آگهی
    • app_title
      • توضیحات : عنوان اپلیکیشن
    • site_url
      • توضیحات : آدرس سایت – آدرس باید به صورت کامل به همراه http یا https باشد
    • email
      • توضیحات : ایمیل سازنده یا صاحب اپلیکیشن
    • مقادیر دلخواه
      • توضیحات : به همراه مقادیر فوق که اجباری هستند میتوان یکسری اطلاعات دلخواه اضافی به همراه درخواست ثبت کرد ٬ به طور مثال ممکن است نیاز داشته باشید که نام و نام خانوادگی یا شماره تلفن و … از کاربران خود دریافت کنید ٬ این مقادیر را میتوانید با عناوین دلخواه در سیستم ثبت کنید ٬ در مثالی که در ادامه وجود دارد “نام” و “موبایل” به صورت مقادیر دلخواه آورده شده است.
  • خروجی‌

    • status
      • توضیحات : وضعیت درخواست
      • مقادیر
        • error : خطایی در ثبت اپلیکیشن رخ داده است.
        • success :‌اپلیکیشن با موفقیت ثبت شده است باید منتظر خروجی باشید.
    • app_id
      • توضیحات : کلید اپ ثبت شده ٬ این کلید برای دریافت خروجی مورد نیاز است.
    • message
      • توضیحات : پیامی که سیستم ارسال کرده است
    • code
      • توضیحات : کد خطا یا موفقیت
      • مقادیر
        • ۱ : اپ با موفقیت ساخته شده است
        • -۳ : پکیج نیم تکراری است
        • -۵ : ورودی های نامعتبر است
        • ۰ : api_key یا username اشتباه است
    • errors
      • توضیحات : پیغام خطا در صورتی که سیستم با خطا مواجه شود.

 

  • نمونه ورودی

  • نمونه خروجی

  • نمونه کد

     

 

دریافت خروجی اپلیکیشن

  • نام متد : get_app
  • آدرس متد : ‌ http://mr2app.com/api/reseller/get_app
  • توضیحات : پس از ثبت اپلیکیشن با متد create_app درخواست ساخت خروجی اپ به سرور کامپایل ارسال میشود ممکن است ٬ آماده شدن خروجی اپلیکیشن چند دقیقه (بین ۲۰ ثانیه تا ۳ دقیقه ) زمان ببرد ٬ از طریق این متد میتوان وضعیت خروجی را چک کرد. پیشنهاد میشود این متد تا زمانی که خروجی آماده میشود در یک loop پانزده ثانیه‌ای قرار گیرد و بعد از اتمام کار از loop خارج شود.
  • ورودی‌ (JSON – POST)

    • username
      • توضیحات : نام کاربری یا ایمیل شما در سیستم مستر۲اپ
    • api_key
      • توضیحات : این کلید را باید از بخش پشتیبانی دریافت کنید.
    • app_id
      • توضیحات : کلید اپ که از متد create_app خروجی گرفته شده است
  • خروجی

    • status
      • توضیحات : وضعیت خروجی اپلکیشن
      • مقادیر
        • ۱ : خروجی آماده شده است
        • ۰ : خروجی آماده نیست
        • -۶ : کلید اپ اشتباه است
    • app_id
      • توضیحات : کلید اپ که در ورودی ارسال شده است
    • apk
      • توضیحات : لینک دانلود اپلیکیشن
    • ver_number
      • توضیحات : شماره نسخه اپلیکیشن
    • ver_name
      • توضیحات : عنوان نسخه اپلیکیشن
    • request_time
      • توضیحات : زمان ارسال درخواست ساخت خروجی به صورت timestamp
    • done_time
      • توضیحات : زمان تکمیل خروجی به صورت timestamp
  • نمونه ورودی

  • نمونه خروجی

     

  • نمونه کد PHP

     

 

اتصال API  به FTP :

اپلیکیشن‌های ساخته شده با API به صورت پیش‌فرض بر روی FTP مستر۲اپ آپلود میشوند که آدرس دانلود آنها به صورت زیر است.

http://dl.mr2app.com/apk/FILE-NAME.apk

این قابلیت بر روی API وجود دارد که آدرس ذخیره سازی فایل خروجی به آدرس FTP  شما تغییر پیدا کند ٬ جهت تغییر آدرس میتوانید اطلاعات زیر را از طریق تیکت به بخش پشتیبانی ارسال نمایید.

  • آدرس FTP
  • FTP username
  • FTP password
  • FTP port (معمولا به صورت پیش فرض ۲۱ است)
  • آدرس پوشه‌ در FTP (مثال : domains//mr2app.com//public_html//dl)
  • آدرس پوشه در پروتکل HTTP (مثال : http://dl.mr2app.com/apk )

 

 




بدون برچسب

مقالات مرتبط

نظرات