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 ที่ทำการทดสอบ ฟังก์ชันที่เกี่ยวข้องจะมีคำใบ้เหมือนด้านล่างใน docstring ของฟังก์ชันที่เกี่ยวข้อง
IMPORTANT - This test method and the parameters used depend on the target system!
เรายินดีอย่างยิ่งที่จะร่วมสนับสนุนโค้ดเพิ่มเติมโดยใช้สาขาฟีเจอร์ที่เกี่ยวข้องและคำขอดึงข้อมูล ฟังก์ชันใหม่ควรรวมกรณีทดสอบตามลำดับเสมอ (ซึ่งสามารถปรับเปลี่ยนเป็นระบบทดสอบอัตโนมัติเมื่อมีการร้องขอรวม)+
นอกจากนี้ยังมี main.ipynb ซึ่งสามารถใช้เพื่อดำเนินการเดี่ยวๆ ได้อย่างรวดเร็วโดยไม่ต้องเขียนโปรเจ็กต์ Python แยกกัน
ทดสอบกับ Churchtools API ปัจจุบัน ณ เดือนกันยายน 2024 (CT 3.101) ข้อมูลเพิ่มเติมอยู่ในหน้า ChurchTools ที่เกี่ยวข้อง
https://YOUR_DOMAIN/api/
วิธีการเข้าถึงล่าสุด - ควรใช้กับทุกสิ่งที่สามารถเข้าถึงได้ผ่าน API นี้ สามารถดูเอกสารประกอบของจุดสิ้นสุดเพิ่มเติมได้โดยเปิด URL ที่เกี่ยวข้อง โมดูลนี้ได้รับการพัฒนาเพื่อรองรับกรณีการใช้งานเฉพาะโดยผู้ร่วมให้ข้อมูลทั้งหมด - อุปกรณ์ปลายทางบางตัวอาจยังไม่ได้ใช้งาน!
https://api.church.tools/index.html
API เดิมที่ใช้โดย WebUI ซึ่งรวมถึงจุดสิ้นสุดบางส่วนที่ยังไม่ได้นำมาใช้ใน REST API ฟังก์ชั่นบางอย่างสามารถวิศวกรรมย้อนกลับได้โดยใช้ Web-Developer Console เพื่อตรวจสอบคำขอ API อาจมีการเปลี่ยนแปลงและอาจหยุดทำงานกับรุ่นในอนาคต!
นอกจากนี้ยังใช้เวลานานกว่า REST API เนื่องจากมักจะสืบค้นชุดข้อมูลขนาดใหญ่แทนที่จะเป็นรายการใดรายการหนึ่ง
รหัสนี้มาพร้อมกับใบอนุญาต CC-BY-SA ดู https://creativecommons.org/licenses/by-sa/2.0/ สำหรับรายละเอียด
กล่าวโดยย่อหมายความว่า - อย่าลังเลที่จะทำอะไรกับมัน แต่คุณจะต้องเผยแพร่การเปลี่ยนแปลงหรือฟังก์ชันเพิ่มเติม (แม้ว่าคุณจะตั้งใจจะเพิ่มฟังก์ชันการทำงานสำหรับตัวคุณเองเท่านั้น!)
ใครก็ตามที่ใช้โค้ดนี้ยินดีที่จะมีส่วนร่วมในการร้องขอการเปลี่ยนแปลงไปยังที่เก็บดั้งเดิม
