ChurchToolsAPI
Version 1.7.0
Mengunduh kode sumber proyek secara default, config.py perlu ditambahkan di folder "aman" untuk eksekusi default. Perlu diketahui bahwa ini akan mencakup informasi sensitif dan tidak boleh dibagikan dengan pihak ketiga dan oleh karena itu disertakan dalam gitignore
Seharusnya terlihat seperti ini:
# 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'}
Jika Anda ingin menggunakan kode ini sebagai modul python, kelas tertentu akan memerlukan params yang mirip dengan file konfigurasi untuk mengakses sistem Anda
Rilis terbaru dapat ditemukan di https://github.com/bensteUEM/ChurchToolsAPI/releases
Itu dapat diinstal menggunakan pip install git+https://github.com/bensteUEM/[email protected]#egg=churchtools-api' menggantikan XXX dengan nomor versi yang dirilis
CT_TOKEN dapat diperoleh/diubah menggunakan opsi "Berechtigungen" pengguna yang harus digunakan untuk mengakses instance CT. Sangat disarankan untuk menyiapkan pengguna khusus dengan izin minimal untuk digunakan dengan modul ini. Namun harap periksa file log dan harapkan hasil yang tidak lengkap jika pengguna meminta izin.
Skrip terakhir diperbarui menggunakan VS Code. Kasus pengujian (misalnya dari test_ChurchToolsApi.py) dijalankan secara otomatis saat dikirim ke GitHub. Hal ini memastikan bahwa fungsionalitas dasar diperiksa terhadap setidaknya satu lingkungan. Repo Github melakukan pengujian terhadap mesin virtual produksi pemilik untuk memastikan data yang cocok untuk pengujian.
Perlu diketahui bahwa beberapa kasus pengujian memerlukan ID khusus untuk ada di server CT yang diuji. Masing-masing fungsi memiliki petunjuk seperti di bawah ini dalam dokumen fungsi masing-masing
IMPORTANT - This test method and the parameters used depend on the target system!
Anda dipersilakan untuk menyumbangkan kode tambahan menggunakan masing-masing cabang fitur dan permintaan penarikan. Fungsi baru harus selalu menyertakan kasus pengujian masing-masing (yang dapat disesuaikan dengan sistem pengujian otomatis berdasarkan permintaan penggabungan)+
Ada juga main.ipynb yang dapat digunakan untuk menjalankan tindakan tunggal dengan cepat tanpa menulis proyek python terpisah
Diuji terhadap API Churchtools saat ini mulai September 2024 (CT 3.101). Informasi lebih lanjut tersedia di halaman ChurchTools masing-masing.
https://DOMAIN_ANDA/api/
Metode akses terbaru - harus digunakan untuk apa pun yang dapat diakses melalui API ini. Dokumentasi titik akhir tambahan dapat ditemukan dengan membuka URL masing-masing. Modul ini dikembangkan untuk mendukung kasus penggunaan spesifik oleh semua kontributor - beberapa titik akhir mungkin belum diimplementasikan!
https://api.church.tools/index.html
API lama yang digunakan oleh WebUI yang mencakup beberapa titik akhir yang belum diimplementasikan ke dalam REST API. Beberapa fungsi dapat direkayasa balik menggunakan Konsol Pengembang Web untuk memantau permintaan. API ini dapat berubah dan mungkin berhenti berfungsi pada rilis mendatang!
Ini juga lebih memakan waktu dibandingkan REST api karena sering kali menanyakan kumpulan data yang besar, bukan item tertentu.
Kode ini diberikan dengan lisensi CC-BY-SA Lihat https://creativecommons.org/licenses/by-sa/2.0/ untuk detailnya.
Singkatnya, ini berarti - jangan ragu untuk melakukan apa pun dengannya, TETAPI Anda diharuskan untuk memublikasikan perubahan atau fungsi tambahan apa pun (bahkan jika Anda bermaksud menambahkan fungsi untuk diri Anda sendiri saja!)
Siapa pun yang menggunakan kode ini dipersilakan untuk berkontribusi dengan permintaan perubahan ke repositori asli.
