API چیست، چگونه آن را راه‌اندازی و اعتبار آن را تمدید کنیم

API چیست؟

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

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

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

مستندات استفاده از API کوینکس

https://docs.coinex.com/api/v2/changelog

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

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

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

3. [ملاحظات API] (یعنی نام API) و [آدرس IP قابل اعمال] را به درستی تنظیم کنید، در صورت نیاز گزینه‌های [قابل برداشت] و/یا [قابل معامله] را تیک بزنید، کد تایید دو عاملی (پیامک/TOTP/کلید عبور) را وارد کنید و سپس پس از تأیید روی [فعال سازی] کلیک کنید.

نکات:

(1) هنگام وارد کردن آدرس IP متصل، لطفاً آدرس IP عمومی دستگاهی که از API استفاده می‌کند را وارد کنید (IPv4 و IPv6 پشتیبانی می‌شوند).

(2) اگر چندین آدرس IP نیاز دارید، آنها را به صورتی وارد کنید که هر آدرس IP در یک خط جداگانه باشد، حداکثر 50 مورد مجاز است.

(3) اگر IP ثابتی متصل نشود، API پس از 90 روز منقضی می‌شود و در آن زمان نیاز به تمدید خواهد داشت.

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

چگونه اعتبار API را تمدید کنیم؟

1. یک API که به آدرس IP متصل نیست، دوره اعتبار 90 روزه دارد. برای تمدید آن، کافی است در صفحه "مدیریت API" روی [تمدید] کلیک کنید.

2. پس از گذراندن تأیید دو عاملی، یک پنجره پاپ‌آپ نشان می‌دهد که تمدید با موفقیت انجام شده است.

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

1. به صفحه "مدیریت API" مراجعه کنید و روی [اضافه کردن آدرس در لیست سفید] کلیک کنید.

2. [برداشت عادی] یا [انتقال درون برنامه ای]، [نوع آدرس]، [کوین] و [زنجیره عمومی] را انتخاب کنید، [آدرس] و [توضیحات] را پر کنید، روی [تایید] کلیک کنید و کد تایید دو عاملی (پیامک/TOTP/کلید عبور) را وارد کنید.

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

4. [کوین]، [زنجیره عمومی] و [آدرس] را در ایمیل خود تأیید کنید و روی [تأیید مجدد] کلیک کنید.

5. مجدداً روی [تایید] کلیک کنید.

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

نکات:

(1) کوینکس قابلیت‌هایی قدرتمند از API را ارائه می‌دهد که به کاربران امکان دسترسی به خدماتی مانند استعلام داده‌های بازار، معاملات، واریز و برداشت از طریق API را می‌دهد.

(2) هر کاربر می‌تواند تا 50 جفت کلید ایجاد کند که هر کلید از حداکثر 50 آدرس IP متصل پشتیبانی می‌کند.

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

(4) پس از فعال‌سازی، API در مدت 10-15 دقیقه فعال خواهد شد.

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

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

2. روی [دانلود] کلیک کنید و داده‌های مربوطه را در صفحه اضافه کردن آپلود کنید، شامل [نکات]، [کوین]، [شبکه]، [آدرس]، [ممو]، روی [تایید] کلیک کنید و کد تایید دو عاملی را وارد کنید، سپس واردات داده‌ها را تکمیل کنید.

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

4. [کوین]، [زنجیره عمومی] و [آدرس] را در ایمیل خود تأیید کنید و روی [تأیید مجدد] کلیک کنید.

5. مجدداً روی [تایید] کلیک کنید.

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

نکات:

(1) حداکثر 100 آدرس لیست سفید را می‌توان همزمان اضافه کرد.

(2) فقط فایل‌های با فرمت CSV پشتیبانی می‌شوند.

(3) "شبکه" در فایل CSV باید با نوع زنجیره عمومی در صفحه واریز مطابقت داشته باشد. به عنوان مثال، هنگام اضافه کردن توکن CET، نوع بلاکچین مربوط به آدرس، CSC Smart Chain است.

شما می‌توانید با فراخوانی API assets/deposit - withdraw - config اطلاعات مربوطه را بازیابی کنید، که در آن ccy مربوط به کوین و chain مربوط به شبکه است.