توثيق واجهات (API)

توثيق عمليات الواجهات الخارجية، مع أمثلة جاهزة للنسخ ونماذج للطلب والاستجابة.

نظرة عامة

الوصول إلى المحتوى المعجمي العربي الموثوق، بما يشمل المداخل المعجمية، والمعاني، والجذور، والأمثلة، والعلاقات اللغوية، والبيانات المرتبطة بالكلمات.

عنوان الأساس (Base URL): https://siwar.ksaa.gov.sa/api/v1/external
الإصدار: v1

نموذج تجريبي: البيانات المعروضة توضيحية وغير مرتبطة بخدمات إنتاجية.

المصادقة وإنشاء المفتاح

تُنفَّذ المصادقة عبر مفتاح (API) يُرسل في ترويسة اسمها (apikey) بالحروف الصغيرة مع كل طلب. يُصدر المفتاح عبر نموذج طلب الوصول ويصلك بالبريد الشبكي. لا تضع المفتاح في الرمز البرمجي للواجهة الأمامية ولا في مستودع عام.

HTTP

GET https://siwar.ksaa.gov.sa/api/v1/external/public/search?query=%D9%85%D8%AD%D8%B1%D9%83
apikey: YOUR_API_KEY
Accept: application/json

إرسال أول طلب

انسخ أحد الأمثلة التالية، واستبدل (YOUR_API_KEY) بمفتاحك، ثم نفّذ الطلب.

cURL

curl -X GET "https://siwar.ksaa.gov.sa/api/v1/external/public/lexicons" \
  -H "apikey: YOUR_API_KEY"

العمليات (Endpoints)

GET/public/lexiconsمتاحة

قائمة المعاجم العامة

يعيد المعاجم العامة المتاحة ومعرّفاتها. ابدأ من هنا: المعرّف (lexiconId) المُعاد هو ما تمرره في معامل (lexiconIds) لبقية العمليات.

المصادقة: مطلوبة (apikey)

المعاملات

الاسم	الموضع	النوع	إلزامي	الوصف
apikey	header	string	نعم	مفتاح الوصول الخاص بالتطبيق. يُرسل في ترويسة اسمها (apikey) بالحروف الصغيرة.

حالات الاستجابة

200— نُفّذ الطلب بنجاح.
401— المفتاح مفقود أو غير صالح أو غير نشط أو منتهي الصلاحية، أو استُنفد حد الاستدعاءات.

نموذج الاستجابة

JSON

[
  {
    "_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    "name": "معجم توضيحي",
    "title": "معجم عام معاصر",
    "version": "1.0",
    "publisherName": "مجمع الملك سلمان العالمي للغة العربية",
    "isPublic": true,
    "totalEntriesCount": 21400
  }
]

أمثلة برمجية

cURL

curl -X GET "https://siwar.ksaa.gov.sa/api/v1/external/public/lexicons" \
  -H "apikey: YOUR_API_KEY"

فتح بيئة الألعاب

GET/public/searchمتاحة

البحث عن كلمة — عام

يبحث في المداخل المعجمية ويعيد مصفوفة بالنتائج المطابقة مع بيانات المدخل كاملة.

المصادقة: مطلوبة (apikey)

المعاملات

الاسم	الموضع	النوع	إلزامي	الوصف
query	query	string	نعم	الكلمة المراد البحث عنها، مثل: محرك.
lexiconIds	query	string	لا	معرّفات المعاجم مفصولة بفواصل (اختياري). اتركه فارغًا للبحث في جميع المعاجم العامة.
apikey	header	string	نعم	مفتاح الوصول الخاص بالتطبيق. يُرسل في ترويسة اسمها (apikey) بالحروف الصغيرة.

حالات الاستجابة

200— نُفّذ الطلب بنجاح.
400— معامل مفقود أو غير صالح (query أو lexiconIds).
401— المفتاح مفقود أو غير صالح أو غير نشط أو منتهي الصلاحية، أو استُنفد حد الاستدعاءات.

نموذج الاستجابة

JSON

[
  {
    "_id": "0f6b1c4e-7d2a-4b13-9c8e-51a0d3f26b74",
    "lexicalEntryId": "0f6b1c4e-7d2a-4b13-9c8e-51a0d3f26b74",
    "lexiconId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    "lexiconName": "معجم توضيحي",
    "lemma": "مُحَرِّك",
    "nonDiacriticsLemma": "محرك",
    "pos": "اسم",
    "root": "ح ر ك",
    "pattern": "مُفَعِّل",
    "senses": [
      { "definition": "جهاز يحوّل صورة من الطاقة إلى حركة." }
    ],
    "isWordFormMatch": false,
    "isLemmatizer": false,
    "isSynonym": false,
    "sortGroupOrder": 1,
    "lexiconSearchOrder": 3
  }
]

أمثلة برمجية

cURL

curl -X GET "https://siwar.ksaa.gov.sa/api/v1/external/public/search?query=%E2%80%A6" \
  -H "apikey: YOUR_API_KEY"

فتح بيئة الألعاب

GET/private/searchمتاحة

البحث عن كلمة — خاص

يبحث في المداخل المعجمية ويعيد مصفوفة بالنتائج المطابقة مع بيانات المدخل كاملة.

المصادقة: مطلوبة (apikey)

المعاملات

الاسم	الموضع	النوع	إلزامي	الوصف
query	query	string	نعم	الكلمة المراد البحث عنها، مثل: محرك.
lexiconIds	query	string	نعم	معرّفات المعاجم مفصولة بفواصل. إلزامي في النطاق الخاص. استخدم (/public/lexicons) للحصول عليها.
apikey	header	string	نعم	مفتاح الوصول الخاص بالتطبيق. يُرسل في ترويسة اسمها (apikey) بالحروف الصغيرة.

حالات الاستجابة

200— نُفّذ الطلب بنجاح.
400— معامل مفقود أو غير صالح (query أو lexiconIds).
401— المفتاح مفقود أو غير صالح أو غير نشط أو منتهي الصلاحية، أو استُنفد حد الاستدعاءات.
403— المفتاح لا يملك صلاحية على المعاجم المطلوبة.

نموذج الاستجابة

JSON

[
  {
    "_id": "0f6b1c4e-7d2a-4b13-9c8e-51a0d3f26b74",
    "lexicalEntryId": "0f6b1c4e-7d2a-4b13-9c8e-51a0d3f26b74",
    "lexiconId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    "lexiconName": "معجم توضيحي",
    "lemma": "مُحَرِّك",
    "nonDiacriticsLemma": "محرك",
    "pos": "اسم",
    "root": "ح ر ك",
    "pattern": "مُفَعِّل",
    "senses": [
      { "definition": "جهاز يحوّل صورة من الطاقة إلى حركة." }
    ],
    "isWordFormMatch": false,
    "isLemmatizer": false,
    "isSynonym": false,
    "sortGroupOrder": 1,
    "lexiconSearchOrder": 3
  }
]

أمثلة برمجية

cURL

curl -X GET "https://siwar.ksaa.gov.sa/api/v1/external/private/search?query=%E2%80%A6&lexiconIds=%E2%80%A6" \
  -H "apikey: YOUR_API_KEY"

فتح بيئة الألعاب

GET/public/sensesمتاحة

المعاني — عام

يعيد تعريفات المدخل المعجمي المطابق مع اسم المعجم الذي ورد فيه.

المصادقة: مطلوبة (apikey)

المعاملات

الاسم	الموضع	النوع	إلزامي	الوصف
query	query	string	نعم	الكلمة المراد البحث عنها، مثل: محرك.
lexiconIds	query	string	لا	معرّفات المعاجم مفصولة بفواصل (اختياري). اتركه فارغًا للبحث في جميع المعاجم العامة.
apikey	header	string	نعم	مفتاح الوصول الخاص بالتطبيق. يُرسل في ترويسة اسمها (apikey) بالحروف الصغيرة.

حالات الاستجابة

200— نُفّذ الطلب بنجاح.
400— معامل مفقود أو غير صالح (query أو lexiconIds).
401— المفتاح مفقود أو غير صالح أو غير نشط أو منتهي الصلاحية، أو استُنفد حد الاستدعاءات.

نموذج الاستجابة

JSON

[
  {
    "lemma": "مُحَرِّك",
    "lexiconName": "معجم توضيحي",
    "senses": ["جهاز يحوّل صورة من الطاقة إلى حركة."]
  }
]

أمثلة برمجية

cURL

curl -X GET "https://siwar.ksaa.gov.sa/api/v1/external/public/senses?query=%E2%80%A6" \
  -H "apikey: YOUR_API_KEY"

فتح بيئة الألعاب

GET/private/sensesمتاحة

المعاني — خاص

يعيد تعريفات المدخل المعجمي المطابق مع اسم المعجم الذي ورد فيه.

المصادقة: مطلوبة (apikey)

المعاملات

الاسم	الموضع	النوع	إلزامي	الوصف
query	query	string	نعم	الكلمة المراد البحث عنها، مثل: محرك.
lexiconIds	query	string	نعم	معرّفات المعاجم مفصولة بفواصل. إلزامي في النطاق الخاص. استخدم (/public/lexicons) للحصول عليها.
apikey	header	string	نعم	مفتاح الوصول الخاص بالتطبيق. يُرسل في ترويسة اسمها (apikey) بالحروف الصغيرة.

حالات الاستجابة

200— نُفّذ الطلب بنجاح.
400— معامل مفقود أو غير صالح (query أو lexiconIds).
401— المفتاح مفقود أو غير صالح أو غير نشط أو منتهي الصلاحية، أو استُنفد حد الاستدعاءات.
403— المفتاح لا يملك صلاحية على المعاجم المطلوبة.

نموذج الاستجابة

JSON

[
  {
    "lemma": "مُحَرِّك",
    "lexiconName": "معجم توضيحي",
    "senses": ["جهاز يحوّل صورة من الطاقة إلى حركة."]
  }
]

أمثلة برمجية

cURL

curl -X GET "https://siwar.ksaa.gov.sa/api/v1/external/private/senses?query=%E2%80%A6&lexiconIds=%E2%80%A6" \
  -H "apikey: YOUR_API_KEY"

فتح بيئة الألعاب

GET/public/examplesمتاحة

الأمثلة الاستعمالية — عام

يعيد الأمثلة الاستعمالية المرتبطة بمعاني المدخل المطابق.

المصادقة: مطلوبة (apikey)

المعاملات

الاسم	الموضع	النوع	إلزامي	الوصف
query	query	string	نعم	الكلمة المراد البحث عنها، مثل: محرك.
lexiconIds	query	string	لا	معرّفات المعاجم مفصولة بفواصل (اختياري). اتركه فارغًا للبحث في جميع المعاجم العامة.
apikey	header	string	نعم	مفتاح الوصول الخاص بالتطبيق. يُرسل في ترويسة اسمها (apikey) بالحروف الصغيرة.

حالات الاستجابة

200— نُفّذ الطلب بنجاح.
400— معامل مفقود أو غير صالح (query أو lexiconIds).
401— المفتاح مفقود أو غير صالح أو غير نشط أو منتهي الصلاحية، أو استُنفد حد الاستدعاءات.

نموذج الاستجابة

JSON

[
  {
    "lemma": "مُحَرِّك",
    "lexiconName": "معجم توضيحي",
    "examples": ["أصلح الفنيُّ محرِّكَ السيارة."]
  }
]

أمثلة برمجية

cURL

curl -X GET "https://siwar.ksaa.gov.sa/api/v1/external/public/examples?query=%E2%80%A6" \
  -H "apikey: YOUR_API_KEY"

فتح بيئة الألعاب

GET/private/examplesمتاحة

الأمثلة الاستعمالية — خاص

يعيد الأمثلة الاستعمالية المرتبطة بمعاني المدخل المطابق.

المصادقة: مطلوبة (apikey)

المعاملات

الاسم	الموضع	النوع	إلزامي	الوصف
query	query	string	نعم	الكلمة المراد البحث عنها، مثل: محرك.
lexiconIds	query	string	نعم	معرّفات المعاجم مفصولة بفواصل. إلزامي في النطاق الخاص. استخدم (/public/lexicons) للحصول عليها.
apikey	header	string	نعم	مفتاح الوصول الخاص بالتطبيق. يُرسل في ترويسة اسمها (apikey) بالحروف الصغيرة.

حالات الاستجابة

200— نُفّذ الطلب بنجاح.
400— معامل مفقود أو غير صالح (query أو lexiconIds).
401— المفتاح مفقود أو غير صالح أو غير نشط أو منتهي الصلاحية، أو استُنفد حد الاستدعاءات.
403— المفتاح لا يملك صلاحية على المعاجم المطلوبة.

نموذج الاستجابة

JSON

[
  {
    "lemma": "مُحَرِّك",
    "lexiconName": "معجم توضيحي",
    "examples": ["أصلح الفنيُّ محرِّكَ السيارة."]
  }
]

أمثلة برمجية

cURL

curl -X GET "https://siwar.ksaa.gov.sa/api/v1/external/private/examples?query=%E2%80%A6&lexiconIds=%E2%80%A6" \
  -H "apikey: YOUR_API_KEY"

فتح بيئة الألعاب

GET/public/synonymsمتاحة

المترادفات — عام

يعيد المترادفات المسجَّلة لمعاني المدخل المطابق.

المصادقة: مطلوبة (apikey)

المعاملات

الاسم	الموضع	النوع	إلزامي	الوصف
query	query	string	نعم	الكلمة المراد البحث عنها، مثل: محرك.
lexiconIds	query	string	لا	معرّفات المعاجم مفصولة بفواصل (اختياري). اتركه فارغًا للبحث في جميع المعاجم العامة.
apikey	header	string	نعم	مفتاح الوصول الخاص بالتطبيق. يُرسل في ترويسة اسمها (apikey) بالحروف الصغيرة.

حالات الاستجابة

200— نُفّذ الطلب بنجاح.
400— معامل مفقود أو غير صالح (query أو lexiconIds).
401— المفتاح مفقود أو غير صالح أو غير نشط أو منتهي الصلاحية، أو استُنفد حد الاستدعاءات.

نموذج الاستجابة

JSON

[
  { "lemma": "مُحَرِّك", "lexiconName": "معجم توضيحي", "synonyms": ["مُشَغِّل"] }
]

أمثلة برمجية

cURL

curl -X GET "https://siwar.ksaa.gov.sa/api/v1/external/public/synonyms?query=%E2%80%A6" \
  -H "apikey: YOUR_API_KEY"

فتح بيئة الألعاب

GET/private/synonymsمتاحة

المترادفات — خاص

يعيد المترادفات المسجَّلة لمعاني المدخل المطابق.

المصادقة: مطلوبة (apikey)

المعاملات

الاسم	الموضع	النوع	إلزامي	الوصف
query	query	string	نعم	الكلمة المراد البحث عنها، مثل: محرك.
lexiconIds	query	string	نعم	معرّفات المعاجم مفصولة بفواصل. إلزامي في النطاق الخاص. استخدم (/public/lexicons) للحصول عليها.
apikey	header	string	نعم	مفتاح الوصول الخاص بالتطبيق. يُرسل في ترويسة اسمها (apikey) بالحروف الصغيرة.

حالات الاستجابة

200— نُفّذ الطلب بنجاح.
400— معامل مفقود أو غير صالح (query أو lexiconIds).
401— المفتاح مفقود أو غير صالح أو غير نشط أو منتهي الصلاحية، أو استُنفد حد الاستدعاءات.
403— المفتاح لا يملك صلاحية على المعاجم المطلوبة.

نموذج الاستجابة

JSON

[
  { "lemma": "مُحَرِّك", "lexiconName": "معجم توضيحي", "synonyms": ["مُشَغِّل"] }
]

أمثلة برمجية

cURL

curl -X GET "https://siwar.ksaa.gov.sa/api/v1/external/private/synonyms?query=%E2%80%A6&lexiconIds=%E2%80%A6" \
  -H "apikey: YOUR_API_KEY"

فتح بيئة الألعاب

GET/public/oppositesمتاحة

الأضداد — عام

يعيد الأضداد المسجَّلة لمعاني المدخل المطابق.

المصادقة: مطلوبة (apikey)

المعاملات

الاسم	الموضع	النوع	إلزامي	الوصف
query	query	string	نعم	الكلمة المراد البحث عنها، مثل: محرك.
lexiconIds	query	string	لا	معرّفات المعاجم مفصولة بفواصل (اختياري). اتركه فارغًا للبحث في جميع المعاجم العامة.
apikey	header	string	نعم	مفتاح الوصول الخاص بالتطبيق. يُرسل في ترويسة اسمها (apikey) بالحروف الصغيرة.

حالات الاستجابة

200— نُفّذ الطلب بنجاح.
400— معامل مفقود أو غير صالح (query أو lexiconIds).
401— المفتاح مفقود أو غير صالح أو غير نشط أو منتهي الصلاحية، أو استُنفد حد الاستدعاءات.

نموذج الاستجابة

JSON

[
  { "lemma": "حركة", "lexiconName": "معجم توضيحي", "opposites": ["سُكون"] }
]

أمثلة برمجية

cURL

curl -X GET "https://siwar.ksaa.gov.sa/api/v1/external/public/opposites?query=%E2%80%A6" \
  -H "apikey: YOUR_API_KEY"

فتح بيئة الألعاب

GET/private/oppositesمتاحة

الأضداد — خاص

يعيد الأضداد المسجَّلة لمعاني المدخل المطابق.

المصادقة: مطلوبة (apikey)

المعاملات

الاسم	الموضع	النوع	إلزامي	الوصف
query	query	string	نعم	الكلمة المراد البحث عنها، مثل: محرك.
lexiconIds	query	string	نعم	معرّفات المعاجم مفصولة بفواصل. إلزامي في النطاق الخاص. استخدم (/public/lexicons) للحصول عليها.
apikey	header	string	نعم	مفتاح الوصول الخاص بالتطبيق. يُرسل في ترويسة اسمها (apikey) بالحروف الصغيرة.

حالات الاستجابة

200— نُفّذ الطلب بنجاح.
400— معامل مفقود أو غير صالح (query أو lexiconIds).
401— المفتاح مفقود أو غير صالح أو غير نشط أو منتهي الصلاحية، أو استُنفد حد الاستدعاءات.
403— المفتاح لا يملك صلاحية على المعاجم المطلوبة.

نموذج الاستجابة

JSON

[
  { "lemma": "حركة", "lexiconName": "معجم توضيحي", "opposites": ["سُكون"] }
]

أمثلة برمجية

cURL

curl -X GET "https://siwar.ksaa.gov.sa/api/v1/external/private/opposites?query=%E2%80%A6&lexiconIds=%E2%80%A6" \
  -H "apikey: YOUR_API_KEY"

فتح بيئة الألعاب

GET/public/posمتاحة

القسم النحوي — عام

يعيد القسم النحوي للمدخل المطابق مع تعريفاته.

المصادقة: مطلوبة (apikey)

المعاملات

الاسم	الموضع	النوع	إلزامي	الوصف
query	query	string	نعم	الكلمة المراد البحث عنها، مثل: محرك.
lexiconIds	query	string	لا	معرّفات المعاجم مفصولة بفواصل (اختياري). اتركه فارغًا للبحث في جميع المعاجم العامة.
apikey	header	string	نعم	مفتاح الوصول الخاص بالتطبيق. يُرسل في ترويسة اسمها (apikey) بالحروف الصغيرة.

حالات الاستجابة

200— نُفّذ الطلب بنجاح.
400— معامل مفقود أو غير صالح (query أو lexiconIds).
401— المفتاح مفقود أو غير صالح أو غير نشط أو منتهي الصلاحية، أو استُنفد حد الاستدعاءات.

نموذج الاستجابة

JSON

[
  {
    "lemma": "مُحَرِّك",
    "lexiconName": "معجم توضيحي",
    "pos": "اسم",
    "senses": ["جهاز يحوّل صورة من الطاقة إلى حركة."]
  }
]

أمثلة برمجية

cURL

curl -X GET "https://siwar.ksaa.gov.sa/api/v1/external/public/pos?query=%E2%80%A6" \
  -H "apikey: YOUR_API_KEY"

فتح بيئة الألعاب

GET/private/posمتاحة

القسم النحوي — خاص

يعيد القسم النحوي للمدخل المطابق مع تعريفاته.

المصادقة: مطلوبة (apikey)

المعاملات

الاسم	الموضع	النوع	إلزامي	الوصف
query	query	string	نعم	الكلمة المراد البحث عنها، مثل: محرك.
lexiconIds	query	string	نعم	معرّفات المعاجم مفصولة بفواصل. إلزامي في النطاق الخاص. استخدم (/public/lexicons) للحصول عليها.
apikey	header	string	نعم	مفتاح الوصول الخاص بالتطبيق. يُرسل في ترويسة اسمها (apikey) بالحروف الصغيرة.

حالات الاستجابة

200— نُفّذ الطلب بنجاح.
400— معامل مفقود أو غير صالح (query أو lexiconIds).
401— المفتاح مفقود أو غير صالح أو غير نشط أو منتهي الصلاحية، أو استُنفد حد الاستدعاءات.
403— المفتاح لا يملك صلاحية على المعاجم المطلوبة.

نموذج الاستجابة

JSON

[
  {
    "lemma": "مُحَرِّك",
    "lexiconName": "معجم توضيحي",
    "pos": "اسم",
    "senses": ["جهاز يحوّل صورة من الطاقة إلى حركة."]
  }
]

أمثلة برمجية

cURL

curl -X GET "https://siwar.ksaa.gov.sa/api/v1/external/private/pos?query=%E2%80%A6&lexiconIds=%E2%80%A6" \
  -H "apikey: YOUR_API_KEY"

فتح بيئة الألعاب

GET/public/rootمتاحة

جذر المدخل — عام

يعيد جذر المدخل المعجمي المطابق. ملاحظة: هذه العملية تنطلق من الكلمة إلى جذرها، ولا تستعرض مشتقات جذر معطى.

المصادقة: مطلوبة (apikey)

المعاملات

الاسم	الموضع	النوع	إلزامي	الوصف
query	query	string	نعم	الكلمة المراد البحث عنها، مثل: محرك.
lexiconIds	query	string	لا	معرّفات المعاجم مفصولة بفواصل (اختياري). اتركه فارغًا للبحث في جميع المعاجم العامة.
apikey	header	string	نعم	مفتاح الوصول الخاص بالتطبيق. يُرسل في ترويسة اسمها (apikey) بالحروف الصغيرة.

حالات الاستجابة

200— نُفّذ الطلب بنجاح.
400— معامل مفقود أو غير صالح (query أو lexiconIds).
401— المفتاح مفقود أو غير صالح أو غير نشط أو منتهي الصلاحية، أو استُنفد حد الاستدعاءات.

نموذج الاستجابة

JSON

[
  { "lemma": "مُحَرِّك", "lexiconName": "معجم توضيحي", "root": "ح ر ك" }
]

أمثلة برمجية

cURL

curl -X GET "https://siwar.ksaa.gov.sa/api/v1/external/public/root?query=%E2%80%A6" \
  -H "apikey: YOUR_API_KEY"

فتح بيئة الألعاب

GET/private/rootمتاحة

جذر المدخل — خاص

يعيد جذر المدخل المعجمي المطابق. ملاحظة: هذه العملية تنطلق من الكلمة إلى جذرها، ولا تستعرض مشتقات جذر معطى.

المصادقة: مطلوبة (apikey)

المعاملات

الاسم	الموضع	النوع	إلزامي	الوصف
query	query	string	نعم	الكلمة المراد البحث عنها، مثل: محرك.
lexiconIds	query	string	نعم	معرّفات المعاجم مفصولة بفواصل. إلزامي في النطاق الخاص. استخدم (/public/lexicons) للحصول عليها.
apikey	header	string	نعم	مفتاح الوصول الخاص بالتطبيق. يُرسل في ترويسة اسمها (apikey) بالحروف الصغيرة.

حالات الاستجابة

200— نُفّذ الطلب بنجاح.
400— معامل مفقود أو غير صالح (query أو lexiconIds).
401— المفتاح مفقود أو غير صالح أو غير نشط أو منتهي الصلاحية، أو استُنفد حد الاستدعاءات.
403— المفتاح لا يملك صلاحية على المعاجم المطلوبة.

نموذج الاستجابة

JSON

[
  { "lemma": "مُحَرِّك", "lexiconName": "معجم توضيحي", "root": "ح ر ك" }
]

أمثلة برمجية

cURL

curl -X GET "https://siwar.ksaa.gov.sa/api/v1/external/private/root?query=%E2%80%A6&lexiconIds=%E2%80%A6" \
  -H "apikey: YOUR_API_KEY"

فتح بيئة الألعاب

GET/public/patternمتاحة

الوزن الصرفي — عام

يعيد الوزن الصرفي للمدخل المعجمي المطابق.

المصادقة: مطلوبة (apikey)

المعاملات

الاسم	الموضع	النوع	إلزامي	الوصف
query	query	string	نعم	الكلمة المراد البحث عنها، مثل: محرك.
lexiconIds	query	string	لا	معرّفات المعاجم مفصولة بفواصل (اختياري). اتركه فارغًا للبحث في جميع المعاجم العامة.
apikey	header	string	نعم	مفتاح الوصول الخاص بالتطبيق. يُرسل في ترويسة اسمها (apikey) بالحروف الصغيرة.

حالات الاستجابة

200— نُفّذ الطلب بنجاح.
400— معامل مفقود أو غير صالح (query أو lexiconIds).
401— المفتاح مفقود أو غير صالح أو غير نشط أو منتهي الصلاحية، أو استُنفد حد الاستدعاءات.

نموذج الاستجابة

JSON

[
  { "lemma": "مُحَرِّك", "lexiconName": "معجم توضيحي", "pattern": "مُفَعِّل" }
]

أمثلة برمجية

cURL

curl -X GET "https://siwar.ksaa.gov.sa/api/v1/external/public/pattern?query=%E2%80%A6" \
  -H "apikey: YOUR_API_KEY"

فتح بيئة الألعاب

GET/private/patternمتاحة

الوزن الصرفي — خاص

يعيد الوزن الصرفي للمدخل المعجمي المطابق.

المصادقة: مطلوبة (apikey)

المعاملات

الاسم	الموضع	النوع	إلزامي	الوصف
query	query	string	نعم	الكلمة المراد البحث عنها، مثل: محرك.
lexiconIds	query	string	نعم	معرّفات المعاجم مفصولة بفواصل. إلزامي في النطاق الخاص. استخدم (/public/lexicons) للحصول عليها.
apikey	header	string	نعم	مفتاح الوصول الخاص بالتطبيق. يُرسل في ترويسة اسمها (apikey) بالحروف الصغيرة.

حالات الاستجابة

200— نُفّذ الطلب بنجاح.
400— معامل مفقود أو غير صالح (query أو lexiconIds).
401— المفتاح مفقود أو غير صالح أو غير نشط أو منتهي الصلاحية، أو استُنفد حد الاستدعاءات.
403— المفتاح لا يملك صلاحية على المعاجم المطلوبة.

نموذج الاستجابة

JSON

[
  { "lemma": "مُحَرِّك", "lexiconName": "معجم توضيحي", "pattern": "مُفَعِّل" }
]

أمثلة برمجية

cURL

curl -X GET "https://siwar.ksaa.gov.sa/api/v1/external/private/pattern?query=%E2%80%A6&lexiconIds=%E2%80%A6" \
  -H "apikey: YOUR_API_KEY"

فتح بيئة الألعاب

GET/public/conjugationsمتاحة

الصيغ الصرفية — عام

يعيد الصيغ الصرفية للمدخل المطابق مع رموز الجنس والعدد وأسمائها.

المصادقة: مطلوبة (apikey)

المعاملات

الاسم	الموضع	النوع	إلزامي	الوصف
query	query	string	نعم	الكلمة المراد البحث عنها، مثل: محرك.
lexiconIds	query	string	لا	معرّفات المعاجم مفصولة بفواصل (اختياري). اتركه فارغًا للبحث في جميع المعاجم العامة.
apikey	header	string	نعم	مفتاح الوصول الخاص بالتطبيق. يُرسل في ترويسة اسمها (apikey) بالحروف الصغيرة.

حالات الاستجابة

200— نُفّذ الطلب بنجاح.
400— معامل مفقود أو غير صالح (query أو lexiconIds).
401— المفتاح مفقود أو غير صالح أو غير نشط أو منتهي الصلاحية، أو استُنفد حد الاستدعاءات.

نموذج الاستجابة

JSON

[
  {
    "lemma": "مُحَرِّك",
    "lexiconName": "معجم توضيحي",
    "wordForms": [
      {
        "value": "مُحَرِّكات",
        "genderCode": "feminine",
        "genderName": "مؤنث",
        "numberCode": "plural",
        "numberName": "جمع"
      }
    ]
  }
]

أمثلة برمجية

cURL

curl -X GET "https://siwar.ksaa.gov.sa/api/v1/external/public/conjugations?query=%E2%80%A6" \
  -H "apikey: YOUR_API_KEY"

فتح بيئة الألعاب

GET/private/conjugationsمتاحة

الصيغ الصرفية — خاص

يعيد الصيغ الصرفية للمدخل المطابق مع رموز الجنس والعدد وأسمائها.

المصادقة: مطلوبة (apikey)

المعاملات

الاسم	الموضع	النوع	إلزامي	الوصف
query	query	string	نعم	الكلمة المراد البحث عنها، مثل: محرك.
lexiconIds	query	string	نعم	معرّفات المعاجم مفصولة بفواصل. إلزامي في النطاق الخاص. استخدم (/public/lexicons) للحصول عليها.
apikey	header	string	نعم	مفتاح الوصول الخاص بالتطبيق. يُرسل في ترويسة اسمها (apikey) بالحروف الصغيرة.

حالات الاستجابة

200— نُفّذ الطلب بنجاح.
400— معامل مفقود أو غير صالح (query أو lexiconIds).
401— المفتاح مفقود أو غير صالح أو غير نشط أو منتهي الصلاحية، أو استُنفد حد الاستدعاءات.
403— المفتاح لا يملك صلاحية على المعاجم المطلوبة.

نموذج الاستجابة

JSON

[
  {
    "lemma": "مُحَرِّك",
    "lexiconName": "معجم توضيحي",
    "wordForms": [
      {
        "value": "مُحَرِّكات",
        "genderCode": "feminine",
        "genderName": "مؤنث",
        "numberCode": "plural",
        "numberName": "جمع"
      }
    ]
  }
]

أمثلة برمجية

cURL

curl -X GET "https://siwar.ksaa.gov.sa/api/v1/external/private/conjugations?query=%E2%80%A6&lexiconIds=%E2%80%A6" \
  -H "apikey: YOUR_API_KEY"

فتح بيئة الألعاب

GET/public/word-structuresمتاحة

العلاقات الدلالية — عام

يعيد العلاقات الدلالية بين معاني المدخل المطابق ومعانٍ أخرى، مع نوع العلاقة ورمزها.

المصادقة: مطلوبة (apikey)

المعاملات

الاسم	الموضع	النوع	إلزامي	الوصف
query	query	string	نعم	الكلمة المراد البحث عنها، مثل: محرك.
lexiconIds	query	string	لا	معرّفات المعاجم مفصولة بفواصل (اختياري). اتركه فارغًا للبحث في جميع المعاجم العامة.
apikey	header	string	نعم	مفتاح الوصول الخاص بالتطبيق. يُرسل في ترويسة اسمها (apikey) بالحروف الصغيرة.

حالات الاستجابة

200— نُفّذ الطلب بنجاح.
400— معامل مفقود أو غير صالح (query أو lexiconIds).
401— المفتاح مفقود أو غير صالح أو غير نشط أو منتهي الصلاحية، أو استُنفد حد الاستدعاءات.

نموذج الاستجابة

JSON

[
  {
    "lemma": "مُحَرِّك",
    "lexiconName": "معجم توضيحي",
    "structures": [
      {
        "relatedLemma": "آلة",
        "relatedSense": "أداة يُستعان بها على العمل.",
        "relationType": "أعم",
        "relationTypeCode": "hypernym"
      }
    ]
  }
]

أمثلة برمجية

cURL

curl -X GET "https://siwar.ksaa.gov.sa/api/v1/external/public/word-structures?query=%E2%80%A6" \
  -H "apikey: YOUR_API_KEY"

فتح بيئة الألعاب

GET/private/word-structuresمتاحة

العلاقات الدلالية — خاص

يعيد العلاقات الدلالية بين معاني المدخل المطابق ومعانٍ أخرى، مع نوع العلاقة ورمزها.

المصادقة: مطلوبة (apikey)

المعاملات

الاسم	الموضع	النوع	إلزامي	الوصف
query	query	string	نعم	الكلمة المراد البحث عنها، مثل: محرك.
lexiconIds	query	string	نعم	معرّفات المعاجم مفصولة بفواصل. إلزامي في النطاق الخاص. استخدم (/public/lexicons) للحصول عليها.
apikey	header	string	نعم	مفتاح الوصول الخاص بالتطبيق. يُرسل في ترويسة اسمها (apikey) بالحروف الصغيرة.

حالات الاستجابة

200— نُفّذ الطلب بنجاح.
400— معامل مفقود أو غير صالح (query أو lexiconIds).
401— المفتاح مفقود أو غير صالح أو غير نشط أو منتهي الصلاحية، أو استُنفد حد الاستدعاءات.
403— المفتاح لا يملك صلاحية على المعاجم المطلوبة.

نموذج الاستجابة

JSON

[
  {
    "lemma": "مُحَرِّك",
    "lexiconName": "معجم توضيحي",
    "structures": [
      {
        "relatedLemma": "آلة",
        "relatedSense": "أداة يُستعان بها على العمل.",
        "relationType": "أعم",
        "relationTypeCode": "hypernym"
      }
    ]
  }
]

أمثلة برمجية

cURL

curl -X GET "https://siwar.ksaa.gov.sa/api/v1/external/private/word-structures?query=%E2%80%A6&lexiconIds=%E2%80%A6" \
  -H "apikey: YOUR_API_KEY"

فتح بيئة الألعاب

رموز الحالة ومعالجة الأخطاء

الرمز	المعنى	الإجراء المقترح
٤٠٠	طلب غير صالح	تأكد من إرسال معامل (query)، ومن إرسال معامل (lexiconIds) في عمليات النطاق الخاص.
٤٠١	مفتاح مفقود أو غير صالح أو منتهٍ، أو استُنفد حد الاستدعاءات	أرسل ترويسة (apikey) بمفتاح فاعل. إذا كان المفتاح صحيحًا فقد استُنفد حد الاستدعاءات المرتبط به؛ راجع الرسالة في جسم الاستجابة.
٤٠٣	لا توجد صلاحية على المعاجم المطلوبة	تحقق من أن المفتاح مصرَّح له بالمعاجم الممرَّرة في معامل (lexiconIds).
٥٠٠	خطأ غير متوقع	أعد المحاولة لاحقًا. لا تُصدر الواجهة حاليًّا معرّف طلب، لذا أرفق المسار والوقت عند التواصل مع الدعم.

JSON

{
  "statusCode": 401,
  "error": "HttpExceptions",
  "message": ["max limit calls exceeded for this api key"]
}

حقل (message) مصفوفة دائمًا، حتى عند وجود رسالة واحدة. لا تُصدر الواجهة حاليًّا معرّف طلب (request id)، لذا اعتمد على المسار ووقت الطلب عند التواصل مع الدعم.

حدود الاستخدام

لكل مفتاح حد تراكمي لعدد الاستدعاءات (٥٠٠٠ استدعاء افتراضيًّا) يُحتسب على عمر المفتاح كاملًا، لا حدًّا لكل دقيقة أو لكل يوم. يُزاد العدّاد مع كل طلب ناجح، وعند بلوغ الحد تعيد الواجهة الرمز (٤٠١).

JSON

{
  "statusCode": 401,
  "error": "HttpExceptions",
  "message": ["max limit calls exceeded for this api key"]
}

لا تُصدر الواجهة حاليًّا الرمز (٤٢٩) ولا ترويسات (X-RateLimit-*) ولا ترويسة (Retry-After). لا تبنِ منطق إعادة المحاولة على أيٍّ منها؛ اعتمد على الرمز (٤٠١) مع نص الرسالة.

تقسيم النتائج (Pagination)

تقسيم النتائج غير متاح حاليًّا. تعيد كل العمليات مصفوفة (JSON) في المستوى الأعلى دون غلاف ودون حقول (total) أو (page) أو (limit)، ولا تقبل معاملي (skip) و(limit). إن كانت مجموعة النتائج كبيرة فقلّص نطاق البحث عبر معامل (lexiconIds).

JSON

[
  { "lemma": "مُحَرِّك", "lexiconName": "…", "root": "ح ر ك" },
  { "lemma": "مِحْراك", "lexiconName": "…", "root": "ح ر ك" }
]

الإصدارات وسياسة الإيقاف

يُحدَّد الإصدار في المسار. تعمل الواجهة الخارجية حاليًّا بإصدار واحد هو (v1)، ولم يُوقف أي إصدار حتى الآن. تُنشر التغييرات في سجل التحديثات. لا تُرسل الواجهة حاليًّا ترويسة (Deprecation)، فلا تبنِ منطقك على وجودها.

سياسات الاستخدام

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

اتفاقية الاستخدام سياسة البيانات