الانتقال إلى المحتوى الرئيسي

مفاتيح API

جميع نقاط v1 تتطلب مفتاح API في ترويسة x-api-key.

إنشاء مفاتيح API

  1. سجّل الدخول إلى لوحة AFKCrypto
  2. انتقل إلى قسم API Keys
  3. انقر “Generate API Key”
  4. امنح المفتاح اسمًا وصفيًا
  5. اختياري: عيّن مدة انتهاء (7 أيام، 30 يومًا، 90 يومًا، 180 يومًا أو سنة)
  6. انسخ المفتاح فورًا — لن يُعرض مرة أخرى

تنسيق المفتاح

afk_<prefix>_<random>

مثال: afk_xY3z_Ab12cD34Ef56Gh78Ij90Kl12Mn34Op56
  • Prefix: معرّف من 4 أحرف للعثور السريع
  • Random: سلسلة عشوائية بطول 32 حرفًا آمنة تشفيريًا

استخدام مفاتيح API

أدرج المفتاح في كل طلب ضمن ترويسة x-api-key:
curl -X GET https://api.afkcrypto.com/api/v1/wallets \
  -H "x-api-key: afk_xY3z_Ab12cD34Ef56Gh78Ij90Kl12Mn34Op56"

أفضل ممارسات الأمان

  • لا تُدرج مفاتيح API في نظام التحكم بالإصدارات — استخدم متغيرات البيئة
  • دوّر المفاتيح بانتظام — استخدم الانتهاء للوصول المؤقت
  • استخدم مفاتيح منفصلة لكل بيئة — التطوير، الاختبار، الإنتاج
  • ألغِ فورًا المفاتيح غير المستخدمة — لتقليل سطح الهجوم
  • خزّنها بأمان — استخدم مدير أسرار (مثل AWS Secrets Manager أو HashiCorp Vault)

انتهاء صلاحية المفتاح

يمكن لمفاتيح API أن تنتهي صلاحيتها بعد مدة محددة:
  • لا تنتهي (افتراضيًا): تعمل حتى الإلغاء
  • 7 أيام: اختبار/عروض قصيرة المدى
  • 30 يومًا: وصول المتعاقدين أو التجارب
  • 90 يومًا: تدوير فصلي موصى به
  • 180 يومًا: تدوير نصف سنوي
  • سنة واحدة: تدوير سنوي للتكاملات المستقرة
ماذا يحدث عند انتهاء الصلاحية؟
  • تعيد الطلبات بهذا المفتاح HTTP 401 UNAUTHORIZED
  • يبقى المفتاح ظاهرًا في اللوحة للأغراض التدقيقية
  • أنشئ مفتاحًا جديدًا لاستبداله
مراقبة الانتهاء:
  • تعرض اللوحة الحالة “Expired” أو “Expiring soon” (≤ 7 أيام)
  • اضبط التنبيهات لتجنّب الانقطاع

حدود المفاتيح

  • أقصى عدد مفاتيح نشطة: 10 لكل مستخدم
  • تُطبّق حدود المعدّل: راجع Rate limiting
  • ألغِ المفاتيح غير المستخدمة للبقاء ضمن الحد

إلغاء مفاتيح API

ألغِ المفتاح فورًا عبر اللوحة:
  1. افتح API Keys
  2. اعثر على المفتاح المراد إلغاؤه
  3. انقر “Revoke Key”
  4. أكّد الإجراء
ملاحظة: الإلغاء نهائي ويُطبَّق فورًا.

روابط ذات صلة