ابدأ هنا
المصادقة
يحمل كل استدعاء مفتاح API في جسم الطلب. يحدد المفتاح الحساب، ويطبّق حدّ المعدل الخاص به، ويقصر كل إجراء على بيانات ذلك الحساب.
أين تضع المفتاح
مرّر المفتاح في حقل key داخل جسم الطلب المُرمّز على هيئة form-encoded. المصادقة عبر الترويسات غير مدعومة — تستخدم مواصفة v2 معاملات الجسم للتوافق مع مجموعات تطوير الموزّعين الحالية.
Content-Type: application/x-www-form-urlencoded
key=YOUR_API_KEY&action=servicesكيف ترسل طلبًا
أرسل POST إما بحقول نموذج (application/x-www-form-urlencoded) أو بكائن JSON له الأسماء المسطحة نفسها. يمكن أن يصل حجم الجسم إلى 32 كيلوبايت كحد أقصى. تُتجاهل المعاملات غير المعروفة، وتُعامل القيمة الفارغة على أنها غير موجودة. أي طريقة أخرى تُرفض برمز METHOD_NOT_ALLOWED.
ما الذي يُفحص في كل طلب
يُفحص المفتاح والحساب ومفتاح تشغيل API من جديد في كل استدعاء، لذا يتوقف الحساب المعلّق أو المفتاح الملغى عن العمل فورًا. يجب أن يكون الحساب نشطًا وبريده الإلكتروني موثّقًا.
- 401
INVALID_KEY
Invalid API keyالمفتاح مفقود أو خاطئ أو ملغى. صحّح الطلب أولًا.
- 403
INACTIVE_ACCOUNT
Account suspendedالحساب موقوف. صحّح الطلب أولًا.
- 403
EMAIL_UNVERIFIED
Email verification requiredالبريد الإلكتروني للحساب لم يُوثَّق بعد. صحّح الطلب أولًا.
- 503
API_DISABLED
The API is temporarily disabledAPI متوقفة مؤقتًا لفترة قصيرة. يبيّن Retry-After متى تعيد المحاولة. قد تفيد إعادة المحاولة.
- 405
METHOD_NOT_ALLOWED
Use POSTلم يكن الطلب من نوع POST. صحّح الطلب أولًا.
- 413
BODY_TOO_LARGE
Request body too largeجسم الطلب كبير جدًا. صحّح الطلب أولًا.
key=YOUR_API_KEY&action=balance{
"error": "Invalid API key",
"error_code": "INVALID_KEY",
"retryable": false
}إنشاء المفاتيح واستبدالها
تُنشأ المفاتيح وتُلغى من /dashboard/api. تُعرض قيمة المفتاح الأصلية مرة واحدة فقط. يحتفظ الخادم بأداة تحقق أحادية الاتجاه ومعرّف قصير غير سري، لذلك لا يمكن استعادة القيمة الأصلية لاحقًا.
حد أقصى 5 مفاتيح نشطة
لكل حساب. يمكن إبطال المفاتيح القديمة كلٌ على حدة.استبدال بلا توقف.
أنشئ مفتاحًا بديلًا، وحدّث التكامل، ثم ألغِ المفتاح القديم. تُرفض الطلبات الجديدة التي تستخدم مفتاحًا ملغى.يلزم وجود جلسة لوحة تحكم نشطة.
يتطلب الإنشاء جلسة موثّقة لا تنتحل مستخدمًا آخر. ولا يضيف طلبًا آخر لرمز بريد إلكتروني أو كلمة مرور.
ما لا يستطيع مفتاح API فعله
يقتصر مفتاح API للإصدار v3 على الإجراءات الموثقة، ولا يتيح الوصول إلى جلسة لوحة تحكم مسجّل الدخول إليها أو بيانات حسابات أخرى.
- سحب الرصيد أو تحويله.
- تغيير بريد الحساب الإلكتروني، أو كلمة المرور، أو إعدادات المصادقة الثنائية.
- إنشاء مفاتيح API أخرى أو إلغاؤها عبر API.
- الوصول إلى نقاط النهاية الإدارية أو نقاط الإشراف.
حافظ على أمان مفتاحك
- من جانب الخادم فقط. لا تُضمّن أبدًا مفتاح API داخل حزمة متصفح، أو تطبيق جوال، أو أي عميل يمكن لطرف آخر تفكيكه.
- استخدم متغيرات البيئة. لا تُودِع المفاتيح في git. مكان ملفات
.envهو.gitignore. - ألغِ المفتاح عند الاشتباه. إذا ظهر مفتاح في سجل أو لقطة شاشة أو محادثة مشتركة، فأنشئ بديلًا وألغِ المفتاح المكشوف.
- استخدم webhooks لتقليل الاستعلام المتكرر عندما يكون ذلك مفيدًا. التسليم بأفضل جهد مع إعادة المحاولة؛ اجعل المعالجات متكافئة عند التكرار ووفّق الحالة المهمة باستخدام
action=status.