API چیست؟

API مخفف «Application Programming Interface» (واسط برنامه‌نویسی برنامه کاربردی) و شامل مجموعه‌ای از توابع و رویه‌ها برای ایجاد برنامه‌هایی کاربردی با قابلیت استفاده از ویژگی‌ها یا داده‌های سیستم‌های عامل، برنامه‌های کاربردی یا سایر خدمات است. به بیان ساده، API ابزار توسعه ساده و قدرتمندی برای کمک به کاربران جهت ادغام سریع و کارآمد توابع معاملاتی کوینکس با برنامه‌های طراحی‌شده توسط خودشان است.

در چه مواردی می‌توانم از API استفاده کنم؟

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

اسناد API کوینکس 

https://viabtc.github.io/coinex_api_en_doc/ 

چگونه API ایجاد کنیم؟

۱. به وب‌سایت رسمی کوینکس (https://www.coinex.com) سر بزنید، وارد حساب خود شوید و روی [حساب] و سپس [مدیریت API] در گوشه بالا سمت چپ کلیک کنید.

۲. پس از ورود به صفحه "مدیریت API" روی [ایجاد API] کلیک کنید.

۳. [یادداشت API] (یعنی نام API) و [آدرس IP قابل‌اعمال] موردنظرتان را وارد کنید. در صورت تمایل، تیک گزینه‌های [قابل‌برداشت] و/یا [قابل معامله] را علامت بزنید. کد ۲FA را وارد و پس از تایید روی [ایجاد] کلیک کنید.

 نکته:

(۱) لطفاً در قسمت «آدرس IP قابل‌اعمال» آدرس IP «دستگاه API موردنیاز» را وارد کنید.

(۲) در هر خط فقط یک آدرس IP و حداکثر ۵۰ آدرس IP می‌توان وارد کرد.

(۳) لطفاً در صورت عدم تعیین آدرس IP قابل‌اعمال هر ۹۰ روز یک‌بار API خود را به‌روزرسانی کنید.

۴. پس از ایجاد موفق API، لطفاً از [نام کاربری Access ID ] و [رمز ورود Secret Key] خود به‌گونه‌ای ایمن نگهداری کنید و اطلاعات این صفحه را با دیگران به اشتراک نگذارید.

مدت اعتبار API را چگونه افزایش دهیم؟

API به یک آدرس IP متصل نیست و مدت اعتبار آن 90 روزه است.

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

چگونه آدرس جدید به لیست مجاز اضافه کنیم؟

۱. وارد صفحه [مدیریت API] شوید و روی [افزودن آدرس به لیست مجاز] کلیک کنید.

۲. [برداشت معمولی] یا [انتقال درون برنامه]، [نوع آدرس]، [کوین] و [زنجیره عمومی] موردنظرتان را انتخاب کنید و پس از وارد کردن [آدرس] و [یادداشت] روی [تأیید] کلیک و کد ۲FA را وارد کنید.

۳. پس از تأیید کد ۲FA یک ایمیل تأیید دریافت خواهید کرد. در صورت عدم دریافت ایمیل تأیید لطفاً روی [ارسال مجدد ایمیل] در صفحه جزئیات آدرس کلیک کنید.

۴. صحت نوع [کوین]، [زنجیره‌ی عمومی] و [آدرس] دریافتی از طریق ایمیل را بررسی و روی [تأیید مجدد] کلیک کنید.

۵. روی [تأیید] کلیک کنید.

۶. آدرس جدید به لیست مجاز با موفقیت اضافه خواهد شد. برای مشاهده جزئیات روی [مشاهده جزئیات] کلیک کنید یا صفحه [مدیریت API] را مشاهده کنید.

 لطفا توجه داشته باشید:

(۱)  APIهای قوی کوینکس امکان استفاده از خدماتی مانند استعلام بازار، معامله، واریز و برداشت را دارند.

(۲)  هر کاربر حداکثر می‌تواند ۵۰ جفت کلید مخفی را ایجاد کند.

(۳)  هر جفت کلید مخفی API معادل جفت «نام‌حساب/رمزعبور» است. برای حفظ امنیت حسابتان لطفاً جفت کلیدها را ایمن نگهداری کنید و آن‌ها را به یک IP متصل کنید.

(۴)  هر کلید خصوصی را حداکثر می‌توان به ۵۰ آدرس IP متصل کرد.

(۵)  API ایجاد شده ۱۰ الی ۱۵ دقیقه پس از ایجاد موفق قابل استفاده خواهد بود.

چگونه آدرس‌های جدید را به‌صورت گروهی به لیست مجاز اضافه کنیم؟

۱. به صفحه "مدیریت API" سر بزنید و روی [اضافه کردن گروهی] کلیک کنید.

۲. روی [دانلود] کلیک کنید و داده‌های مربوطه مثل [یادداشت]، [کوین]، [شبکه]، [آدرس]، و [ممو] را آپلود و روی [تأیید] کلیک کنید. کد ۲FA را وارد و ورود داده‌ها را تکمیل کنید.

۳. پس از تأیید کد ۲FA یک ایمیل تأیید دریافت خواهید کرد. در صورت عدم دریافت ایمیل تأیید لطفاً روی [ارسال مجدد ایمیل] در صفحه جزئیات آدرس کلیک کنید.

۴. صحت نوع [کوین]، [زنجیره‌ی عمومی] و [آدرس] دریافتی از طریق ایمیل را بررسی و روی [تأیید مجدد] کلیک کنید.

۵. روی [تأیید] کلیک کنید.

۶. آدرس‌های جدید به‌صورت گروهی با موفقیت به لیست مجاز اضافه خواهند شد. برای مشاهده جزئیات روی [مشاهده جزئیات] کلیک کنید یا صفحه [مدیریت API] را مشاهده کنید.

نکته:

(۱)  در هر بار حداکثر ۱۰۰ آدرس مجاز را می‌توان اضافه کرد.

(۲)  فقط می‌توان از فایل‌هایی با فرمت CSV استفاده کرد.

(۳)  نوع «شبکه» درج شده در فایل CSV باید با «نوع زنجیره عمومی» تعیین‌شده در صفحه واریز مطابقت داشته باشد. برای مثال، اگر نوع زنجیره عمومی در صفحه واریز CSC باشد، نوع شبکه درج شده در فایل نیز باید CSC باشد.

در صورت مواجهه با خطای «تعداد فیلدها مطابقت ندارد»، لطفاً مطابقت شبکه، آدرس یا یادداشت موجود در فایل را بررسی کنید.