المصادقة
يدعم API Handelsregister AI طريقتين للمصادقة: مفتاح API ورمز Bearer. تعمل كلتا الطريقتين على جميع نقاط نهاية API.
طرق المصادقة
x-api-key: YOUR_API_KEY |
مفتاح API عبر رأس الصفحة: موصى به للتكامل بين الخوادم والاستخدام في بيئة الإنتاج |
?api_key=YOUR_API_KEY |
مفتاح API عبر معامل الاستعلام: فقط للاختبار السريع والتوافق مع الإصدارات السابقة |
Authorization: Bearer YOUR_TOKEN |
رمز Bearer: الأفضل للتطبيقات التي تتطلب تحكمًا دقيقًا في الوصول، وانتهاء صلاحية الرمز، وأمانًا محسّنًا |
أمثلة على مصادقة مفتاح API
curl -X GET "https://handelsregister.ai/api/v1/search-organizations?q=company" \
-H "x-api-key: YOUR_API_KEY"
# Using query parameter (legacy)
curl "https://handelsregister.ai/api/v1/fetch-organization?api_key=YOUR_API_KEY&q=company"
# Using x-api-key header (recommended)
curl -X GET "https://handelsregister.ai/api/v1/fetch-organization?q=company" \
-H "x-api-key: YOUR_API_KEY"
إدارة رمز Bearer
إنشاء رمز API
curl -X POST "https://handelsregister.ai/api/v1/auth/tokens/create" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"token_name": "My Application",
"abilities": ["*"],
"expires_at": "2026-01-01 00:00:00"
}'
ستتضمن الاستجابة رمز Bearer الخاص بك. احفظه بأمان!
استخدام رمز Bearer
curl -X GET "https://handelsregister.ai/api/v1/search-organizations?q=company" \
-H "Authorization: Bearer YOUR_API_TOKEN"
نقاط نهاية إدارة الرموز
POST /api/v1/auth/tokens/create |
إنشاء رمز جديد |
GET /api/v1/auth/tokens |
سرد جميع الرموز |
DELETE /api/v1/auth/tokens/{id} |
إلغاء رمز محدد |
DELETE /api/v1/auth/tokens |
إلغاء جميع الرموز |