مفتاح API الخاص بك
أنشئ مفتاح API للمشروع من بطاقة «تكامل الويب الحديث»، وأرسله في الترويسة X-Rankfender-Key، واستبدله بأمان.
تعرف واجهة API للمحتوى المشروع الذي تسأل عنه من مفتاح API الخاص به. لكل مشروع مفتاحه الخاص، يُنشأ على بطاقة «تكامل الويب الحديث» في المشروع. ولا يقرأ المفتاح إلا المقالات المنشورة لذلك المشروع.
أنشئ المفتاح
افتح البطاقة
«إعدادات المشروع ← التكاملات»، ثم «ربط» (أو «تهيئة») على «تكامل الويب الحديث». ابقَ على تبويب «سحب (API)».
انقر «إنشاء مفتاح API»
يظهر المفتاح مع زر «نسخ». يبدأ بـ rfk_ متبوعًا بـ 64 حرفًا ورقمًا.
انقر «اختبار الاتصال»
تؤكد ذلك رسالة «تم الاتصال بنجاح! مفتاح API صالح ويعمل.»
أرسله مع كل طلب
ضع المفتاح في الترويسة X-Rankfender-Key. لا توجد طريقة أخرى لتمريره.
curl "https://api.rankfender.com/functions/v1/public-article-api?limit=1" \
-H "X-Rankfender-Key: rfk_your_key"| الاستجابة | المعنى |
|---|---|
| 401 "API key required. Pass via X-Rankfender-Key header." | الترويسة غير موجودة. |
| 401 "Invalid API key" | المفتاح لا يطابق أي مشروع، مثلًا بعد استبداله. |
استبدل مفتاحًا
انقر «إنشاء مفتاح API» مرة أخرى. يحل المفتاح الجديد محل القديم فورًا: كل موقع لا يزال يستخدم المفتاح القديم يتلقى «Invalid API key» حتى تحدّثه.
مهم
يستطيع أي شخص يملك المفتاح قراءة المقالات المنشورة للمشروع. احتفظ به على خادمك، في متغير بيئة، واستدعِ واجهة API من شيفرة تعمل على الخادم لا من المتصفح.
تعرض «إعدادات الحساب ← مفاتيح API» عبارة «إدارة مفاتيح API قريبًا»: تُدار المفاتيح لكل مشروع على حدة، كما هو موضح أعلاه. التالي: مرجع واجهة API للمحتوى.