ChurchToolsAPI
Version 1.7.0
Al descargar el código fuente del proyecto de forma predeterminada, es necesario agregar un config.py en la carpeta "segura" para la ejecución predeterminada. Tenga en cuenta que esto incluirá información confidencial y nunca debe compartirse con terceros y, por lo tanto, está incluido en gitignore.
Debería verse así:
# 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'}
Si desea utilizar este código como módulo de Python, ciertas clases requerirán parámetros similares al archivo de configuración para poder acceder a su sistema.
La última versión se puede encontrar en https://github.com/bensteUEM/ChurchToolsAPI/releases
Se puede instalar usando pip install git+https://github.com/bensteUEM/[email protected]#egg=churchtools-api' reemplazando XXX por un número de versión publicada
CT_TOKEN se puede obtener/cambiar usando la opción "Berechtigungen" del usuario que debe usarse para acceder a la instancia de CT. Se recomienda encarecidamente configurar un usuario personalizado con permisos mínimos para usar este módulo. Sin embargo, verifique los archivos de registro y espere resultados incompletos si el usuario está perdiendo permisos.
El script se actualizó por última vez usando VS Code. Los casos de prueba (por ejemplo, de test_ChurchToolsApi.py) se ejecutan automáticamente cuando se envían a GitHub. Esto garantiza que la funcionalidad básica se verifique en al menos un entorno. Github Repo realiza pruebas con la instancia de producción del propietario para garantizar que los datos coincidan para las pruebas.
Tenga en cuenta que algunos de los casos de prueba requieren que estén presentes ID específicas en el servidor CT con el que se prueba. La función respectiva tiene una pista como la siguiente en la cadena de documentación de las funciones respectivas
IMPORTANT - This test method and the parameters used depend on the target system!
Eres más que bienvenido a contribuir con código adicional utilizando las respectivas ramas de funciones y solicitudes de extracción. Las nuevas funciones siempre deben incluir los respectivos casos de prueba (que se pueden ajustar al sistema de prueba automatizado previa solicitud de fusión)+
También hay un main.ipynb que se puede usar para ejecutar rápidamente acciones individuales sin escribir un proyecto de Python separado.
Probado con las API actuales de Churchtools a partir de septiembre de 2024 (CT 3.101). Se proporciona más información en las respectivas páginas de ChurchTools.
https://TU_DOMINIO/api/
Método de acceso más reciente: debe usarse para cualquier cosa a la que se pueda acceder a través de esta API. La documentación de puntos finales adicionales se puede encontrar abriendo la URL respectiva. El módulo fue desarrollado para admitir casos de uso específicos por parte de todos los contribuyentes; es posible que algunos puntos finales aún no estén implementados.
https://api.church.tools/index.html
API heredada utilizada por WebUI que incluye algunos puntos finales que aún no se implementaron en la API REST. Algunas funciones se pueden aplicar ingeniería inversa utilizando Web-Developer Console para monitorear las solicitudes. ¡La API está sujeta a cambios y podría dejar de funcionar con cualquier versión futura!
También consume más tiempo que la API REST, ya que a menudo consulta grandes conjuntos de datos en lugar de elementos específicos.
Este código se proporciona con una licencia CC-BY-SA. Consulte https://creativecommons.org/licenses/by-sa/2.0/ para obtener más detalles.
En resumen, esto significa: siéntase libre de hacer cualquier cosa con él, PERO debe publicar cualquier cambio o funcionalidad adicional (¡incluso si tenía la intención de agregar funcionalidad solo para usted!)
Cualquiera que utilice este código es más que bienvenido a contribuir con solicitudes de cambio al repositorio original.
