api آی ماینر | مستندات api | درخواست api

دریافت api آی ماینر | مستندات api

api آی ماینر: برخی از مزایای استفاده از وب سرویس آی ماینر (صرفا ویژه نمایندگان)

وب سرویس های آی‌ماینر همگی مبتنی بر HTTP می باشند در نتیجه در هر محیطی به سادگی می توانید از وب سرویس ها استفاده نمایید.
وب سرویس های آی‌ماینر این امکان را به شما می دهند تا سرویس خود را در محیط هایی همچون وب سایت ها، اپلیکیشن های تحت موبایل، بات های شبکه های اجتماعی و … پیاده سازی نمایید.
امکان حذف برند آی‌ماینر در تمامی خدمات دهی.
استفاده از وب سرویس های مربوط به نرخ ارزها رایگان است و نیاز به احراز هویت ندارد.
تمامی وب سرویس ها در کلاد بارگزاری شده اند و متخصصین آی‌ماینر ، پیوسته در تلاش اند تا نرخ پاسخگویی را در پایین ترین حالت خود نگه دارند.
محیط تست و یا Sandbox در آی‌ماینر توسط ارزهای مبتنی بر تست نت پشتیبانی می شود.

قبل از شروع به موارد زیر توجه نمایید:

آدرس پایه کلیه ی وب سرویس ها https://api.iminer.net می باشد.
کلیه ی وب سرویس ها مبتنی بر JSON می باشند. پس هنگام فراخوانی وب سرویس ها و ارسال اطلاعات به این موضوع توجه نمایید.
توسعه دهندگان می توانند از تست نت ها برای تست ارتباطات و منطق پرداخت خود استفاده نمایند.
منطقه زمانی (Time Zone) کلیه واحد های زمانی متناسب با تظیمات پذیرنده در پنل کاربری می باشد. منطقه زمانی پیشفرض UTC است.
در حال حاضر تمامی اعلان ها توسط وب هوک ها پردازش می شوند از این جهت پیشنهاد می شود که وب سایت خود را مجهز به SSL نمایید. پس از اضافه شدن روشی دیگر جهت ارسال و دریافت اعلان ها، استفاده از وب هوک ها فقط منوط به وجود SSL در پذیرنده خواهد بود.
Signature یا امضای پذیرنده محرمانه می باشد. به هیچ عنوان در اختیار کاربران وب سایت خود قرار ندهید.
تمامی پرداخت ها به دلیل نوسانات ارزش ارز های دیجیتال، دارای تاریخ انقضا می باشند. به این معنا که کاربر می بایست در مدت معینی اقدام به انجام تراکنش نماید، مقدار پیشفرض این مدت زمان در حال حاضر 15 دقیقه است که شما می توانید از طریق وب سرویس issue، آن را تا 2 روز تغییر دهید. در صورتی که این زمان به پایان برسد، پرداخت به صورت خودکار باطل خواهد شد و اگر تراکنشی بعد از این مدت زمان در شبکه دیده شود، به صورت واریز عادی پردازش می شود.
آدرس های ارائه شده در وب سرویس issue الزاما منحصر به فرد نیستند. آدرس های ارائه شده در پرداخت ها یا جدید ایجاد شده اند یا از آدرس های قدیمی (که حداقل 7 روز از تاریخ ایجاد آنها می گذرد) مجدد استفاده شده است. سپس این آدرس ها موقتا برای پرداخت جاری رزرو می شوند. اگر پرداخت منقضی یا تکمیل شود، آدرس ها از رزرو خارج می شوند و ممکن است در آینده مجدد استفاده شوند. در کل، هر چقدر مقدار پرداخت در روز شما بر روی درگاهی بیشتر باشد، احتمال دریافت آدرس تکراری کمتر است.

جدول راهنمای خروجی های api آی ماینر

خروجی تمام وب سرویس های بخش پرداخت، شامل یک مدل مشخص و ثابت می باشد، که مقدار خروجی در فیلد result قرار می گیرد:

نام فیلد	نوع فیلد	اجباری	شرح
`hasError`	`boolean`	*	در صورتی که `true` باشد خطایی رخ داده است
`errorMessage`	`string`		پیام مربوط به خطای رخ داده
`errorCode`	`number`		شماره شناسه خطا
`result`	`object/value`		در صورتی که خطایی رخ داده باشد این فیلد `null` است

با توجه به جدول فوق، مقادیر ممکن برای errorCode و توضیحات مربوط به آن در جدول زیر شرح داده شده است:

مقدار errorCode	شرح خطا
`0`	خطای داخلی رخ داده است
`1`	امضای پذیرنده اشتباه یا پذیرنده تایید نشده است
`2`	مقادیر ارسالی اشتباه است
`3`	کد رهگیری وارد شده اشتباه است
`4`	پرداخت در وضعیت نهایی نمی باشد
`5`	پرداخت قبلا از سمت پذیرنده تایید شده است
`6`	`token` پرداخت اشتباه است
`7`	پرداخت منقضی یا باطل شده است
`8`	پرداخت بسته شده است

ساختار داخلی جیب از ورژن 2 به بعد مالتی کوین شده است و به مرور کوین های زیر به سیستم اضافه می شوند. وضعیت کوین ها و کد آنها در زیر شرح داده شده است. توجه داشته باشید که تنها از کوین کد های زیر جهت ایجاد یک پرداخت استفاده کنید:

کد	عنوان	وضعیت
`btc`	بیت کوین	فعال
`tbtc`	بیت کوین تست نت	فعال
`ltc`	لایت کوین	فعال
`tltc`	لایت کوین تست نت	فعال
`eth`	ایتریوم	به زودی
`xrp`	ریپل	به زودی
`bch`	بیت کوین کش	به زودی
`xmr`	مونرو	به زودی

برای استفاده از تست نت ها می توانید از لینک های زیر استفاده نمایید:

عنوان	لینک
بیت کوین تست نت	https://coinfaucet.eu/en/btc-testnet
لایت کوین تست نت	http://testnet.litecointools.com

پرداخت زمانی مالتی کوین می شود که هنگام ایجاد پرداخت، کوین های قابل پرداخت در فیلد coins درج شده باشد. برای مثال اگر مقدار btc/ltc/bch را در فیلد مذکور در وب سرویس ایجاد پرداخت وارد کنید، 3 آدرس بر روی 3 کوین مختلف ایجاد می شود. مبلغ هر کدام از این کوین ها نیز با توجه به فیلد value که واحد آن بیت کوین می باشد تنظیم می شود. حال پرداخت کننده می تواند بین 3 کوین مختلف انتخاب کند و پرداخت را فقط با استفاده از یک کوین تکمیل کند.

جدول وضعیت پرداخت ها

پرداخت در آی‌ماینر می تواند چندین وضعیت داشته باشد که کد و معنای آن در جدول زیر شرح داده شده است:

کد وضعیت پرداخت	شرح
`01`	وضعیت اولیه
`02`	در انتظار تراکنش
`03`	در انتظار دریافت تاییده از شبکه
`04`	تراکنش در جیب نهایی شده است
`05`	پرداخت منقضی و یا توسط کاربر باطل شده است
`06`	مبلغ پرداخت شده از مبلغ درخواستی کمتر است (استرداد پرداخت)
`07`	مبلغ پرداخت شده از مبلغ درخواستی بیشتر است (استرداد پرداخت)