المطورون

واجهة API العامة

اقرأ مواقعك وتقاريرك ومراتبك وكلماتك المفتاحية عبر واجهة API بسيطة تعتمد على مفتاح. ميزة Agency.

واجهة API العامة

توفر واجهة API العامة وصول قراءة فقط إلى البيانات التي يحتفظ بها RankMeFast بالفعل لحسابك — المواقع، وأحدث تقرير تدقيق، وسجل المراتب، والكلمات المفتاحية المتتبعة. إنها ميزة خطة Agency (انظر الخطط والحدود والأرصدة). لا تُطلق واجهة API أبدًا عملًا جديدًا لدى المزوّدين — بل تقرأ فقط ما أنتجته تدقيقاتك وفحوصات المراتب مسبقًا.

المصادقة

أنشئ مفتاحًا من الحساب ← مفاتيح API (/profile?tab=api-keys). يُعرض المفتاح الكامل مرة واحدة فقط — انسخه فورًا؛ وبعدها لن يظهر سوى بادئته. يمكنك الاحتفاظ بما يصل إلى عشرة مفاتيح نشطة وإبطال أي منها في أي وقت. المفتاح المُبطل يتوقف عن العمل فورًا.

أرسل المفتاح كرمز bearer مع كل طلب:

Authorization: Bearer rmf_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

استبدل https://your-rankme-host في الأمثلة أدناه بأصل واجهة api لديك (قيمة SERVER_URL في تنصيبك).

نقاط النهاية

قائمة مواقعك

curl -H "Authorization: Bearer rmf_..." \
  https://your-rankme-host/api/v1/sites

تعيد { "sites": [{ "id", "domain", "url", "createdAt" }] }.

أحدث تقرير تدقيق لموقع

curl -H "Authorization: Bearer rmf_..." \
  https://your-rankme-host/api/v1/sites/<siteId>/report/latest

تعيد أحدث تدقيق ناجح بالشكل { "runId", "report" } — نفس النتائج والفئات والنصوص المترجمة التي تعرضها لوحة التحكم. تجيب بـ 404 إذا لم يكن للموقع تدقيق مكتمل بعد.

سجل المراتب لموقع

curl -H "Authorization: Bearer rmf_..." \
  "https://your-rankme-host/api/v1/sites/<siteId>/rank-history?from=2026-06-01&to=2026-07-01"

تعيد { "keywords": [{ "id", "phrase", "series": [...] }] }. تحمل كل نقطة في السلسلة المرتبة وعنوان URL الذي تصدّر وإشارات Google AI Overview (aiOverviewPresent، aiCited، aiCitedUrl). from وto تاريخان بصيغة ISO اختياريان.

كل الكلمات المفتاحية المتتبعة

curl -H "Authorization: Bearer rmf_..." \
  https://your-rankme-host/api/v1/keywords

تعيد كل كلمة مفتاحية متتبعة عبر جميع مواقعك مع أحدث مرتبة والفرق وحقول AI Overview.

حدود المعدل

افتراضيًا يمكن لكل مفتاح إجراء 120 طلبًا في الدقيقة. بعد ذلك تجيب واجهة API بـ 429 حتى تتم إعادة ضبط النافذة.

الأخطاء

تستخدم الأخطاء الشكل { "error": { "message": "...", "details": ... } } وتُترجم حسب ترويسة Accept-Language:

401 — المفتاح مفقود أو تالف أو مُبطل أو غير معروف.
402 — خطتك لا تتضمن واجهة API.
404 — الموقع أو التقرير غير موجود في حسابك.
429 — تم تجاوز حد المعدل (المحتوى: { "error": "..." }).

التوافق

يوفّر هذا الإصدار أربعة مسارات للقراءة فقط:

GET /api/v1/sites
GET /api/v1/sites/:siteId/report/latest
GET /api/v1/sites/:siteId/rank-history
GET /api/v1/keywords

لا تضيف ميزات رادار العلامة التجارية أو ذكاء المراجعات أو ذكاء الروابط أو تحليلات الزيارات أو اتجاهات الكلمات المفتاحية أو مستشعر SERP أي مسار تحت /api/v1. تظل الميزات الخمس المدفوعة ضمن لوحة التحكم المصادَق عليها، ويظل المستشعر العام تحت /api/volatility. تحتفظ حقول الاستجابة الحالية بمعناها، وعلى العملاء تجاهل أي حقول إضافية لا يعرفونها.

العودة إلى فهرس الوثائق