REST API
توثيق API
الوصول إلى بيانات SkillsMP Skills برمجياً عبر REST API. يدعم البحث بالكلمات المفتاحية والتصفية حسب الفئة والمهنة ولغة محتوى المهارة المكتشفة.
table_of_contents.md
المصادقة
نقاط النهاية
GET /api/v1/skills/search
البحث عن المهارات بالكلمات المفتاحية
| المعامل | النوع | مطلوب | الوصف |
|---|---|---|---|
| q | string | ✓ | استعلام البحث |
| page | number | - | رقم الصفحة (الافتراضي: 1) |
| limit | number | - | عدد العناصر في الصفحة (الافتراضي: 20؛ الحد الأقصى: 50) |
| sortBy | string | - | الترتيب: stars | recent (الافتراضي: recent) |
| category | string | - | صف حسب slug الفئة (مثل data-ai و devops). |
| occupation | string | - | صف حسب slug مهنة SOC (مثل software-developers). |
| language | string | - | صف حسب لغة محتوى Skill المكتشفة. استخدم رمز ISO مثل en أو zh أو ja؛ يعني mul محتوى متعدد اللغات، ويعني und أن اللغة غير محددة. |
حدود الاستخدام
- *وصول مجهول (من دون مفتاح واجهة برمجة): 50 طلب/يوم، 10/دقيقة — البحث بالكلمات المفتاحية فقط
- *وصول موثّق (باستخدام مفتاح واجهة برمجة): 500 طلب/يوم، 30/دقيقة — بحث بالكلمات المفتاحية
- *البحث بأحرف البدل (مثل *) غير مدعوم
عند توفرها، توضّح رؤوس استجابة البحث التالية استخدام الحصة اليومية:
| الرأس | الوصف |
|---|---|
| X-RateLimit-Daily-Limit | حد الطلبات اليومي |
| X-RateLimit-Daily-Remaining | الطلبات المتبقية لهذا اليوم |
أمثلة الكود
البحث بالكلمات المفتاحية
curl -X GET "https://skillsmp.com/api/v1/skills/search?q=SEO" \
-H "Authorization: Bearer sk_live_your_api_key"بحث مع فلتر المهنة
curl -X GET "https://skillsmp.com/api/v1/skills/search?q=automation&occupation=software-developers&language=zh&sortBy=stars" \
-H "Authorization: Bearer sk_live_your_api_key"معالجة الأخطاء
تستخدم API رموز حالة HTTP القياسية وتُرجع تفاصيل الأخطاء بتنسيق JSON.
| رمز الخطأ | HTTP | الوصف |
|---|---|---|
| INVALID_API_KEY | 401 | مفتاح API غير صالح |
| MISSING_QUERY | 400 | معامل الاستعلام المطلوب مفقود |
| INVALID_OCCUPATION | 400 | معرّف المهنة غير معروف |
| INVALID_LANGUAGE | 400 | رمز لغة المحتوى غير معروف |
| DAILY_QUOTA_EXCEEDED | 429 | تم تجاوز حصة API اليومية |
| INTERNAL_ERROR | 500 | خطأ داخلي في الخادم |
مثال على استجابة الخطأ:
json
{
"success": false,
"error": {
"code": "INVALID_API_KEY",
"message": "The provided API key is invalid"
}
}more.md