وثائق واجهة برمجة التطبيقات

واجهة برمجة التطبيقات (API) الخاصة بأعربلي تتيح لك دمج قدرات الإعراب في تطبيقاتك الخاصة. استخدم هذه الواجهة للحصول على إعراب دقيق للجمل العربية برمجياً.

1. التحليل النحوي (الإعراب)

هذا هو نقطة النهاية الرئيسية لتحليل الجملة العربية.

POST GET https://i3rbly.com/api/v3/tool

الوصف: يحلل جملة عربية ويعيد إعرابها كلمة بكلمة. نوصي باستخدام طريقة POST لأنها تتعامل مع الأحرف العربية بشكل أكثر موثوقية.

معاملات الطلب (POST)

المعامل النوع مطلوب الوصف
key String نعم مفتاح واجهة برمجة التطبيقات الشخصي الخاص بك
phrase String نعم الجملة العربية المراد إعرابها (حد أقصى 500 حرف)

مثال على الطلب (curl)

curl -X POST "https://i3rbly.com/api/v3/tool" \
     -H "Content-Type: application/json" \
     -d '{"key": "YOUR_API_KEY", "phrase": "الولدُ يلعبُ بالكرةِ"}'

مثال على الاستجابة الناجحة 200 OK

{
  "إعراب": [
    {
      "الكلمة": "الولدُ",
      "الإعراب": "مبتدأ مرفوع وعلامة رفعه الضمة"
    },
    {
      "الكلمة": "يلعبُ",
      "الإعراب": "فعل مضارع مرفوع وعلامة رفعه الضمة"
    },
    {
      "الكلمة": "بالكرةِ",
      "الإعراب": "جار ومجرور"
    }
  ],
  "الإصدار": "v3",
  "الطلبات_المتبقية": 9
}

أمثلة على أخطاء الاستجابة

401 Unauthorized 401 (مفتاح غير صالح أو مفقود)

{
  "خطأ": "مفتاح واجهة برمجية غير صالح"
}

429 Too Many Requests 429 (تم تجاوز حد الطلبات)

{
  "خطأ": "تم تجاوز حد الطلبات",
  "الرسالة": "تم تجاوز الحد الساعي للطلبات وهو 10 طلب",
  "إعادة_التعيين_بالدقائق": 45
}

2. التحقق من حالة مفتاح واجهة برمجة التطبيقات

استخدم هذه النقطة للتحقق من الاستخدام الحالي والحدود الخاصة بك.

GET https://i3rbly.com/api/v3/status

الوصف: يسترجع الحالة الحالية وإحصائيات الاستخدام لمفتاح واجهة برمجة التطبيقات المحدد.

معاملات الاستعلام

المعامل النوع مطلوب الوصف
key String نعم مفتاح واجهة برمجة التطبيقات الشخصي الخاص بك

مثال على الطلب (curl)

curl "https://i3rbly.com/api/v3/status?key=YOUR_API_KEY"

مثال على الاستجابة الناجحة 200 OK

{
  "الاسم": "Default User",
  "طلبات_الساعة_الحالية": 1,
  "الحد_الساعي": 10,
  "الطلبات_المتبقية": 9,
  "إعادة_التعيين_بالدقائق": 59,
  "فترة_الساعة_الحالية": "2025-11-17 13:00",
  "تاريخ_الإنشاء": "2024-01-01"
}

مثال على الكود (Python)

فيما يلي مثال بسيط لكيفية استخدام واجهة برمجة التطبيقات في Python باستخدام مكتبة requests.

import requests
import json

API_URL = "https://i3rbly.com/api/v3/tool"
API_KEY = "YOUR_API_KEY"  # Replace with your actual key

def get_irab(sentence):
    """
    Calls the i3rbly API to get the I'rab of a sentence.
    """
    headers = {
        'Content-Type': 'application/json'
    }
    payload = {
        'key': API_KEY,
        'phrase': sentence
    }

    try:
        response = requests.post(API_URL, headers=headers, data=json.dumps(payload))
        response.raise_for_status()  # Raise an exception for bad status codes (4xx or 5xx)
        return response.json()
    except requests.exceptions.HTTPError as err:
        print(f"HTTP Error: {err}")
        # Try to print the error response from the API
        try:
            print("API Response:", err.response.json())
        except json.JSONDecodeError:
            print("API Response (raw):", err.response.text)
        return None
    except requests.exceptions.RequestException as err:
        print(f"Request Error: {err}")
        return None

if __name__ == "__main__":
    arabic_sentence = "الشمسُ مشرقةٌ في السماءِ"
    result = get_irab(arabic_sentence)
    if result and 'إعراب' in result:
        print(f"إعراب جملة: '{arabic_sentence}'\n" + "="*30)
        for item in result['إعراب']:
            print(f"{item['الكلمة']}: {item['الإعراب']}")
        
        print("\n" + "="*30)
        print(f"الإصدار: {result.get('الإصدار')}")
        print(f"الطلبات المتبقية هذا الساعة: {result.get('الطلبات_المتبقية')}")