المصادقة

يتطلب كل request إلى FourA API إجراء المصادقة. توضح هذه الصفحة كيفية الحصول على مفتاح API الخاص بك واستخدامه وإدارته.

الحصول على مفتاح API الخاص بك

1. سجّل الدخول إلى لوحة تحكم FourA‏
2. انتقل إلى صفحة API Keys
3. انقر على Create Key
4. انسخ المفتاح من نافذة التأكيد

يبدو مفتاح API الخاص بك على هذا النحو: pk_live_a1b2c3d4e5f6...

المفاتيح التي يتم إنشاؤها اليوم قابلة للإظهار: انقر على أيقونة العين في صف المفتاح لاحقا لعرض المفتاح السري بالكامل عند الطلب (راجع إدارة مفاتيح API‏ لمعرفة خطوات الإظهار والأذونات). لا يمكن عرض المفاتيح القديمة التي تم إنشاؤها قبل توفر ميزة الإظهار وتظهر أيقونة قفل، أعد إنشاءها مرة واحدة للتبديل.

استخدام مفتاح API الخاص بك

قم بتضمين مفتاح API الخاص بك في X-API-Key header لكل request:

curl -X POST https://eu.api.foura.ai/api/single/ \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"method": "GET", "url": "https://example.com"}'

في Python:

import requests

response = requests.post(
    "https://eu.api.foura.ai/api/single/",
    headers={
        "X-API-Key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={"method": "GET", "url": "https://example.com"}
)

في Node.js:

const response = await fetch('https://eu.api.foura.ai/api/single/', {
  method: 'POST',
  headers: {
    'X-API-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ method: 'GET', url: 'https://example.com' })
});

أمان API Key

تعامل مع API key الخاص بك ككلمة مرور:

• لا تقم بتضمينه في أنظمة التحكم في الإصدار. استخدم متغيرات البيئة بدلا من ذلك.
• لا تكشف عنه في كود جانب العميل (client-side). استخدمه فقط في تطبيقات جانب الخادم (server-side).
• قم بتدويره في حال اختراقه. أعد إنشاء المفتاح من Dashboard. سيتوقف السر القديم عن العمل خلال دقيقة واحدة، ويتم تسجيل كل عملية كشف في سجل التدقيق ليسهل اكتشاف بيانات الاعتماد المسروقة بعد وقوع الحادث.

استخدام متغيرات البيئة

احفظ المفتاح الخاص بك في متغير بيئة:

export FOURA_API_KEY="pk_live_a1b2c3d4e5f6..."

ثم قم بالإشارة إليه في التعليمات البرمجية الخاصة بك:

import os
api_key = os.environ["FOURA_API_KEY"]

const apiKey = process.env.FOURA_API_KEY;

أخطاء المصادقة الشائعة

تُرجع جميع حالات فشل المصادقة حالة 401 Unauthorized.

تحتوي كل استجابة، سواء كانت ناجحة أو فاشلة، على ترويسة X-Foura-Request-Id، باستثناء نص الطلب الذي لا يستطيع FourA قراءته على الإطلاق (JSON غير صالح، أو نص يتجاوز 100 كيلوبايت)، حيث يتم رفضه قبل تعيين معرف له. قم بتسجيله في جانبك ليتمكن فريق الدعم من البحث عن استدعاء محدد لاحقا.

الخطوات التالية

• البدء السريع: أرسل أول طلب لك
• إدارة مفاتيح API: عرض المفاتيح وتعديلها وإعادة إنشائها وحذفها
• نقاط نهاية API: مرجع نقاط النهاية الكامل
• معالجة الأخطاء: التعامل مع أخطاء المصادقة بسلاسة