ChurchToolsAPI
Version 1.7.0
Baixando o código fonte do projeto por padrão, um config.py precisa ser adicionado na pasta "segura" para execução padrão. Esteja ciente de que isso incluirá informações confidenciais e nunca deve ser compartilhado com terceiros e, portanto, está incluído no gitignore
Deveria ficar assim:
# 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'}
Se você quiser usar este código como um módulo python, certas classes exigirão parâmetros semelhantes ao arquivo de configuração para acessar seu sistema
A versão mais recente pode ser encontrada em https://github.com/bensteUEM/ChurchToolsAPI/releases
Ele pode ser instalado usando pip install git+https://github.com/bensteUEM/[email protected]#egg=churchtools-api' substituindo XXX por um número de versão lançada
CT_TOKEN pode ser obtido/alterado através da opção "Berechtigungen" do usuário que deve ser utilizada para acessar a instância CT. É altamente recomendável configurar um usuário personalizado com permissões mínimas para uso com este módulo. No entanto, verifique os arquivos de log e espere resultados incompletos se o usuário estiver solicitando permissões.
O script foi atualizado pela última vez usando o VS Code. Os casos de teste (por exemplo, de test_ChurchToolsApi.py) são executados automaticamente quando enviados ao GitHub. Isso garante que a funcionalidade básica seja verificada em pelo menos um ambiente. O Github Repo testa a instância de produção dos proprietários para garantir dados correspondentes para testes.
Esteja ciente de que alguns dos casos de teste exigem a presença de IDs específicos no servidor CT que é testado. A respectiva função tem uma dica como a abaixo na documentação das respectivas funções
IMPORTANT - This test method and the parameters used depend on the target system!
Você é mais que bem-vindo para contribuir com código adicional usando as respectivas ramificações de recursos e solicitações pull. Novas funções devem sempre incluir os respectivos casos de teste (que podem ser ajustados ao sistema de teste automatizado mediante solicitação de mesclagem)+
Há também um main.ipynb que pode ser usado para executar ações únicas rapidamente sem escrever um projeto python separado
Testado em relação às APIs Churchtools atuais em setembro de 2024 (CT 3.101). Mais informações são fornecidas nas respectivas páginas do ChurchTools.
https://SEU_DOMÍNIO/api/
Método de acesso mais recente - deve ser usado para qualquer coisa acessível por meio desta API. A documentação de endpoints adicionais pode ser encontrada abrindo o respectivo URL. O módulo foi desenvolvido para oferecer suporte a casos de uso específicos de todos os contribuidores - alguns endpoints podem não estar implementados ainda!
https://api.church.tools/index.html
API legada usada pela WebUI que inclui alguns endpoints que ainda não foram implementados na API REST. Algumas funções podem passar por engenharia reversa usando o Web-Developer Console para monitorar solicitações. A API está sujeita a alterações e pode parar de funcionar em qualquer versão futura!
Também consome mais tempo do que a API REST, pois geralmente consulta grandes conjuntos de dados em vez de itens específicos.
Este código é fornecido com uma licença CC-BY-SA. Consulte https://creativecommons.org/licenses/by-sa/2.0/ para obter detalhes.
Resumindo, isso significa - sinta-se à vontade para fazer qualquer coisa com ele, MAS você é obrigado a publicar quaisquer alterações ou funcionalidades adicionais (mesmo que pretenda adicionar funcionalidades apenas para você!)
Qualquer pessoa que use este código é bem-vinda para contribuir com solicitações de mudança no repositório original.
