ChurchToolsAPI
Version 1.7.0
تنزيل الكود المصدري للمشروع بشكل افتراضي، يلزم إضافة config.py في المجلد "الآمن" للتنفيذ الافتراضي. يرجى العلم أن هذا سيتضمن معلومات حساسة ويجب عدم مشاركته مطلقًا مع أطراف ثالثة وبالتالي يتم تضمينه في gitignore
يجب أن يبدو مثل هذا:
# COMMENT FOR WHICH USER / DATE this is -> DO NOT SHARE
ct_domain = 'https://YOUR-DOMAIN.DE'
ct_token = 'TOKEN SECRET VERY LONG RANDOM STRING'
ct_users = {'USER_EMAIL': 'USER_PASSWORD'}
إذا كنت تريد استخدام هذا الرمز كوحدة نمطية بيثون، فستتطلب فئات معينة معلمات مشابهة لملف التكوين من أجل الوصول إلى نظامك
يمكن العثور على أحدث إصدار على https://github.com/bensteUEM/ChurchToolsAPI/releases
يمكن تثبيته باستخدام pip install git+https://github.com/bensteUEM/[email protected]#egg=churchtools-api' مع استبدال XXX برقم الإصدار الذي تم إصداره
يمكن الحصول على/تغيير CT_TOKEN باستخدام خيار "Berechtigungen" الخاص بالمستخدم والذي يجب استخدامه للوصول إلى مثيل CT. يوصى بشدة بإعداد مستخدم مخصص مع الحد الأدنى من الأذونات للاستخدام مع هذه الوحدة. ومع ذلك، يرجى التحقق من ملفات السجل وتوقع نتائج غير كاملة إذا كان المستخدم يفتقد الأذونات.
تم تحديث البرنامج النصي آخر مرة باستخدام VS Code. يتم تشغيل حالات الاختبار (على سبيل المثال من test_ChurchToolsApi.py) تلقائيًا عند دفعها إلى GitHub. وهذا يضمن فحص الوظائف الأساسية في بيئة واحدة على الأقل. يتم إجراء اختبارات Github Repo مقابل مثيلات الإنتاج الخاصة بالمالكين من أجل ضمان مطابقة البيانات للاختبارات.
يرجى العلم أن بعض حالات الاختبار تتطلب وجود معرفات محددة على خادم CT الذي يتم اختباره. تحتوي الوظيفة المعنية على تلميح مثل الموجود أدناه في مستندات الوظائف المعنية
IMPORTANT - This test method and the parameters used depend on the target system!
أنت مرحب بك للمساهمة برمز إضافي باستخدام فروع الميزات وطلبات السحب المعنية. يجب أن تتضمن الوظائف الجديدة دائمًا حالات الاختبار المعنية (والتي يمكن تعديلها وفقًا لنظام الاختبار الآلي عند طلب الدمج)+
يوجد أيضًا main.ipynb والذي يمكن استخدامه لتنفيذ إجراءات فردية بسرعة دون كتابة مشروع بايثون منفصل
تم اختباره مقابل واجهات برمجة تطبيقات Churchtools الحالية اعتبارًا من سبتمبر 2024 (CT 3.101). يتم توفير المزيد من المعلومات على صفحات ChurchTools المعنية.
https://YOUR_DOMAIN/api/
أحدث طريقة للوصول - يجب استخدامها لأي شيء يمكن الوصول إليه من خلال واجهة برمجة التطبيقات هذه. يمكن العثور على وثائق نقاط النهاية الإضافية عند فتح عنوان URL المعني. تم تطوير الوحدة لدعم حالات الاستخدام المحددة من قبل جميع المساهمين - ربما لم يتم تنفيذ بعض نقاط النهاية بعد!
https://api.church.tools/index.html
واجهة برمجة التطبيقات القديمة التي تستخدمها واجهة WebUI والتي تتضمن بعض نقاط النهاية التي لم يتم تنفيذها بعد في REST API. يمكن إجراء هندسة عكسية لبعض الوظائف باستخدام Web-Developer Console لمراقبة الطلبات. واجهة برمجة التطبيقات (API) عرضة للتغيير وقد تتوقف عن العمل مع أي إصدار مستقبلي!
كما أنها تستهلك وقتًا أطول من واجهة REST API لأنها تستعلم في كثير من الأحيان عن مجموعات كبيرة من البيانات بدلاً من عناصر محددة.
يتم توفير هذا الرمز مع ترخيص CC-BY-SA راجع https://creativecommons.org/licenses/by-sa/2.0/ للحصول على التفاصيل.
باختصار، هذا يعني - لا تتردد في فعل أي شيء به، ولكن يتعين عليك نشر أي تغييرات أو وظائف إضافية (حتى لو كنت تنوي إضافة وظائف لنفسك فقط!)
نرحب بأي شخص يستخدم هذا الرمز للمساهمة في طلبات التغيير إلى المستودع الأصلي.
