المصادقة

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

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

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

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

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

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

قم بتضمين مفتاح API الخاص بك في header X-API-Key لكل 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

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

• لا تقم بإضافته إلى التحكم في الإصدارات. استخدم متغيرات البيئة بدلا من ذلك.
• لا تعرضه في كود جانب العميل. استخدمه فقط في تطبيقات جانب الخادم.
• قم بتدويره إذا تم اختراقه. أعد إنشاء المفتاح من 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.

يحمل كل response، سواء كان ناجحا أو فاشلا، header X-Foura-Request-Id. قم بتسجيله في نظامك حتى يتمكن الدعم الفني من البحث عن استدعاء محدد لاحقا.

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

• Quick Start: قم بإجراء أول request لك
• Managing API Keys: كشف المفاتيح وتعديلها وإعادة إنشائها وحذفها
• API Endpoints: مرجع endpoint الكامل
• Error Handling: التعامل مع أخطاء المصادقة بسلاسة