توثيق API

مرجع كامل لجميع نقاط نهاية API والميزات

نقاط نهاية API

المقدمة

مرحبًا بكم في توثيق API الشامل لدينا

سريع وموثوق

API عالي الأداء مع زمن انتقال منخفض

آمن

أمان وتشفير على مستوى المؤسسة

شامل

مجموعة كاملة من نقاط النهاية لجميع الاحتياجات

رابط الأساس

https://devsouqhub.com/api/v1

المصادقة

كيفية المصادقة مع API الخاص بنا

مصادقة مفتاح API

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

GET /api/v1/courses?api_key=YOUR_API_KEY

رمز الوصول

وصف رمز الوصول

Authorization: Bearer YOUR_TOKEN

تقييد المعدل

وصف تقييد المعدل

الخطة حد المعدل الانفجار
مجاني 60 الطلبات في الساعة 10 الطلبات في الدقيقة
أساسي 500 الطلبات في الساعة 30 الطلبات في الدقيقة
مميز 2000 الطلبات في الساعة 60 الطلبات في الدقيقة
مؤسسي custom custom

رؤوس حد المعدل

وصف رؤوس حد المعدل

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 56
X-RateLimit-Reset: 1623456789

المصادقة

وصف نقاط نهاية المصادقة

POST
/api/v1/auth/login

وصف تسجيل الدخول API

المعلمات

الاسم النوع هذا الحقل مطلوب الوصف
email string البريد الإلكتروني للمستخدم
password string كلمة مرور المستخدم

response

{
  "success": true,
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "user": {
    "id": 1,
    "username": "johndoe",
    "email": "john@example.com"
  }
}

معالجة الأخطاء

وصف معالجة الأخطاء

رمز الحالة رمز الخطأ الوصف
400 invalid_request خطأ طلب غير صالح
401 unauthorized خطأ غير مصرح
403 forbidden خطأ ممنوع
404 not_found خطأ غير موجود
422 validation_error خطأ التحقق
429 rate_limit_exceeded خطأ حد المعدل
500 server_error خطأ في الخادم
503 service_unavailable خطأ الخدمة غير متوفرة

error_response_example

{
  "success": false,
  "error": {
    "code": "validation_error",
    "message": "The given data was invalid.",
    "details": {
      "email": ["The email field is required."],
      "password": ["The password must be at least 8 characters."]
    }
  }
}

مكتبات SDK

sdk_libraries_description

JavaScript

وصف SDK جافاسكريبت

GitHub docs

PHP

وصف SDK بي إتش بي

GitHub docs

Python

وصف SDK بايثون

GitHub docs

Other Languages

أخرى

GitHub docs

سجل التغييرات

v1.3.0
2023-08-15

ميزات وتحسينات جديدة

  • ...
  • ...
  • ...
v1.2.0
2023-05-20

نقاط نهاية جديدة

  • ...
  • ...
  • ...
v1.1.0
2023-03-10

تحسينات API

  • ...
  • ...
v1.0.0
2023-01-15

الإصدار الأول

  • ...
  • ...
  • ...