دليل API لوركيوم

سوف تتعلم كيفية المصادقة (المصادقة هي عملية التحقق من هوية المستخدم)، الحصول على بيانات الجدول، والحصول على السجلات وإنشاؤها.

المصادقة

‍
تحتاج جميع واجهات برمجة التطبيقات في Workiom إلى مفتاح API لتمريره في الهيدر. يمكنك الحصول على مفتاح API الخاص بك من إعدادات الحساب.

‍

ثم قم بتمريره من خلال الهيدر باستخدام الاسم "X-Api-Key"

مثال:
curl -X GET "https://api.workiom.com/api/services/app/Apps/GetAll" -H "accept: text/plain" -H "X-Api-Key: {مفتاح الواجهة البرمجية الخاص بك}"
‍

‍
الحصول على بيانات القائمة الفرعية

‍
معظم الإجراءات التي قد ترغب في القيام بها على قائمة فرعية ربما تتطلب الحصول أولاً على بياناتها الفرعية. ستحتوي بيانات الاستجابة على العديد من المعلومات المفيدة مثل حقول القائمة والعروض مع معرفيها.

‍

GET `/api/services/app/Lists/Get`Content-Type "application/json"Headers`X-Api-Key {مفتاح الواجهة البرمجية الخاص بك}`Parametersid: stringexpand: array[string] (أي مجموعة من: "الحقول", "العروض", "الفلاتر")

‍
الاستجابة
‍

‍

{ "appId": "string", "fields": [{ "id": 0 "name": "string", "description": "string", "dataType": 0, }], "id": "string" "name": "string", "description": "string"}

‍
الحصول على سجلات القائمة

‍
الحصول على سجلات من القائمة أمر بسيط ومرن. يجب عليك تحديد معرف القائمة الفرعية للحصول على سجلاتها، ولكن يمكنك أيضًا تحديد خيارات الترتيب واستخدام maxResultCount وskipCount للترقيم، أو تمرير مجموعة من كائنات الفلتر للتحكم بدقة أكبر في السجلات التي تحصل عليها.

POST `/api/services/app/Data/All`
Content-Type "application/json"
Headers`X-Api-Key {مفتاح الواجهة البرمجية الخاص بك} `
‍

الجسم
‍

‍
الاستجابة

{ "summary": { "additionalProp1": 0, "additionalProp2": 0, "additionalProp3": 0 }, "totalCount": 0, "items": [ {} ]}

‍
إنشاء سجلات

‍
السجلات هي كائنات JSON بسيطة يكون مفتاح كل منها هو معرف الحقل وقيمته هي قيمة هذا السجل للحقل. قد تحتوي الحقول المختلفة على أنواع بيانات مختلفة، يمكنك العثور على معرف الحقل ونوع البيانات من استجابة بيانات القائمة الفرعية.
‍

POST `/api/services/app/Data/Create`Content-Type "application/json"Headers`X-Api-Key {مفتاح الواجهة البرمجية الخاص بك} `Parameters`listId: string`Body{ // هذا مثال على سجل /* معرف_الحقل: القيمة */ "1186": "2018-11-13T00:00:00

‍
الفلاتر

‍
يمكن استخدام الفلاتر عند طلب البيانات. عادةً ما تكون مجموعة من كائنات الفلتر التي تحتوي على معرف الحقل للفلترة عليه، ومشغل الفلتر وقيمة الفلتر. على سبيل المثال، قد يكون خاصية الفلتر في طلب Data/All كالتالي:
‍

{ "filters": [ { "fieldId": 1425, "operator": 1, "value": "أحمد مسعى" } ]}المشغلات المتاحة للفلتر هي:المحتوى = 1، لا يحتوي على = 2، هو = 3، ليس = 4، أكبر من = 5، أكبر من أو يساوي = 9، أقل من = 6، أقل من أو يساوي = 10، بين = 11، فارغ = 7، غير فارغ = 8، في = 12، ليس في = 13

‍
الترتيب

‍
يمكن إجراء الترتيب باستخدام سلسلة الترتيب التي تحتوي على معرف الحقل الذي سيتم الترتيب عليه واتجاه الترتيب. على سبيل المثال، الترتيب التصاعدي للحقل 11284 هو:

sorting: "11284 ASC"

أما للترتيب التنازلي على نفس الحقل:

sorting: "11284 DESC"
‍

‍
أنواع البيانات

‍
تدعم Workiom العديد من أنواع بيانات الحقول، وتقبل الحقول ذات الأنواع المختلفة قيمًا من أنواع مختلفة. يقبل حقل التاريخ فقط التواريخ، بينما يقبل حقل LinkedList مصفوفة من الكائنات التي تحتوي على معرفات السجلات المرتبطة. تُمثل الأنواع بأرقام النماذج التالية:

‍

نص = 0، رقم = 1، تاريخ ووقت = 2، منطقي = 3، اختيار ثابت = 4، قائمة مرتبطة = 5، مستخدم = 6، موقع ويب = 7، بريد إلكتروني = 8، ملف = 9، مجموعة متداولة = 10، رقم هاتف = 11، عدد = 12، عملة = 13، رقم تلقائي = 14، قائمة مراجعة = 15

‍
تحديث السجلات

‍
تحديثات السجلات بسيطة تقريبًا مثل إنشاء السجل. يجب عليك فقط القيام بمكالمة PUT بدلاً من POST، ويجب توفير معرف السجل بالإضافة إلى معرف القائمة الفرعية. هذا طلب PUT قياسي، لذلك يكون جسم الطلب هو السجل بأكمله مع التغييرات المطبقة على الحقول.

PUT /api/services/app/Data/Update
Content-Type: "application/json"
Headers`X-Api-Key {مفتاح الواجهة البرمجية الخاص بك} `

‍
المعلمات: listId: string, id: string
الجسم

{ "1186": "2019-11-13T00:00:00.000+00:00", "1251": "[[email protected]](/cdn-cgi/l/email-protection)", "1421": [ { "_id": "r29jrg8hgg48g33nig", "label": "سجل مرتبط" }, { "_id": "1354535tregrfrwni2", "label": "سجل مرتبط آخر" } ], "1425": "أحمد لام", "1532": 132, "1563": { "id": "14372839", "label": "عنصر قائمة ثابت" }, "1591": { "id": "28349232", "label": "خالد سميح" } }

‍
تحديث جزئي للسجلات
‍

إذا كنت لا ترغب في إرسال السجل بأكمله في كل عملية تحديث، يمكنك استخدام نقطة النهاية /UpdatePartial، والتي تسمح لك بإرسال فقط الحقول المتغيرة، على عكس نقطة النهاية القياسية في /Update.

PUT `/api/services/app/Data/UpdatePartial`Content-Type: "application/json"Headers: `Authorization Bearer [your-access-token`]Parameters: listId: string, id: stringBody{"1186": "2019-11-13T00:00:00.000+00:00","1251": "[[email protected]](/cdn-cgi/l/email-protection)",}

‍
‍

‍
نوع بيانات الحقول

‍
قائمة مرتبطة: [ { "_id":string, "label":string } ]
قائمة ثابتة { "id":string, "label":string }
مستخدم { "id":int, "username":string }

لأي سؤال، يرجى التواصل معنا عبر البريد الإلكتروني support@workiom.com. إنه دليل عام محدود سيتم تحسينه وتوسيعه مع مرور الوقت. للمزيد من الوثائق الرسمية والشاملة.

المصادر:

المواصفات الفنية للواجهة البرمجية متاحة على: https://api.workiom.com/swagger/.
نقطة النهاية للواجهة البرمجية متاحة على https://api.workiom.com.

‍

إرفاق ملف بسجل

لإرفاق ملف بسجل، يتعين عليك القيام بالخطوات التالية:

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

تحميل الملف

قم بتحميل الملف باستخدام واجهة البرمجة /File/Upload
عند اكتمال التحميل، ستحصل على استجابة تحتوي على معلومات الملف.
احفظ هذه المعلومات لاستخدامها أثناء إنشاء أو تحديث سجل.

استجابة الواجهة البرمجية:

fileName : "اسم_الملف"

fileToken : "رمز_الملف"

fileType : "نوع_الملف/نوع_MIME"

fileUrl : "عنوان_الملف"

hasThumbnail : صحيح/غير_صحيح

thumbnailUrl : "عنوان_المصغرة_للصور" // للملفات الصورية

success : ص true

targetUrl : null

unAuthorizedRequest : false

إنشاء/تحديث السجل

باستخدام معلومات الملف من الخطوة السابقة، سنقوم باستدعاء واجهة إنشاء السجل أو تحديث السجل

لنستخدم 12345 كمعرّف لحقل الملف، باستخدام واجهة التحديث الجزئي

/api/services/app/Data/UpdatePartial?listId=معرّف_القائمة&id=معرّف_السجل

يجب أن نرسل مجموعة من الملفات تبدو هكذا

{

‘12345’: [

{

"AnonymousForm" : false ,

"ContentType" : "نوع_الملف/نوع_MIME" ,

"ExpiryDate" : null ,

"FileName" : "اسم_الملف" ,

"FileUrl" : null ,

"ThumbnailUrl" : null ,

"HasThumbnail" : صحيح/غير_صحيح ,

"IsPermanent" : صحيح ,

"Size" : حجم_الملف ,

"UserId" : معرّف_المستخدم_الحالي ,

"_id" : "رمز_الملف"

}

]

}

يمكننا استخدام نفس الحمولة لواجهة إنشاء السجل /api/services/app/Data/Create?listId=معرّف_القائمة

‍

دليل API لوركيوم

المصادقة

‍
الحصول على بيانات القائمة الفرعية

‍
الحصول على سجلات القائمة

‍
الاستجابة

‍
إنشاء سجلات

‍
الفلاتر

‍
الترتيب

‍
أنواع البيانات

‍
تحديث السجلات

‍
تحديث جزئي للسجلات
‍

‍
نوع بيانات الحقول

إرفاق ملف بسجل

تحميل الملف

إنشاء/تحديث السجل

مقالات ذات صلة

هل تبحث عن شيء اخر؟

لا تزال بحاجة الى مساعدة؟

دليل API لوركيوم

المصادقة

‍الحصول على بيانات القائمة الفرعية

‍الحصول على سجلات القائمة

‍الاستجابة

‍إنشاء سجلات

‍الفلاتر

‍الترتيب

‍أنواع البيانات

‍تحديث السجلات

‍تحديث جزئي للسجلات‍

‍نوع بيانات الحقول

إرفاق ملف بسجل

تحميل الملف

إنشاء/تحديث السجل

مقالات ذات صلة

شارك هذه المقالة

هل تبحث عن شيء اخر؟

لا تزال بحاجة الى مساعدة؟

‍
الحصول على بيانات القائمة الفرعية

‍
الحصول على سجلات القائمة

‍
الاستجابة

‍
إنشاء سجلات

‍
الفلاتر

‍
الترتيب

‍
أنواع البيانات

‍
تحديث السجلات

‍
تحديث جزئي للسجلات
‍

‍
نوع بيانات الحقول