المصادقة
يتطلب كل request إلى FourA API إجراء المصادقة. توضح هذه الصفحة كيفية الحصول على API key الخاص بك واستخدامه وإدارته.
الحصول على API key الخاص بك
- قم بتسجيل الدخول إلى FourA Dashboard
- انتقل إلى صفحة API Keys
- انقر فوق Create Key
- انسخ المفتاح فورًا (لن يتم عرضه بالكامل مرة أخرى)
يبدو API key الخاص بك كما يلي: pk_live_a1b2c3d4e5f6...
استخدام API key الخاص بك
قم بتضمين API key الخاص بك في 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 key
عامل API key الخاص بك ككلمة مرور:
- لا تقم بحفظه في version control. استخدم متغيرات البيئة (environment variables) بدلًا من ذلك.
- لا تكشف عنه في كود 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.
| الخطأ | الرسالة | السبب | الحل |
|---|---|---|---|
| 401 | Missing API key. Include X-API-Key header. | غياب header الـ X-API-Key في الـ request |
أضف header الـ X-API-Key |
| 401 | Invalid API key | مفتاح خاطئ، أو مسافة فارغة زائدة، أو مفتاح تم إلغاء تنشيطه | تحقق من المفتاح، أو قم بإزالة المسافات الفارغة، أو أنشئ مفتاحًا جديدًا من Dashboard |
الخطوات التالية
- Quick Start: قم بإجراء أول request لك
- API Endpoints: مرجع الـ endpoint الكامل
- Error Handling: تعامل مع أخطاء المصادقة بسلاسة