API Pública inChurch

[Documentação completa da API →] https://docs.inchurch.com.br/introduction

O que você aprenderá neste artigo

A API Pública da inChurch permite conectar os recursos da plataforma a sistemas e soluções externas.

Com ela, igrejas e parceiros podem desenvolver integrações personalizadas, automatizar processos e utilizar informações da inChurch em outras ferramentas.

O que é a API Pública da inChurch?

Uma API permite que diferentes sistemas troquem informações entre si.

Na inChurch, a API Pública disponibiliza recursos da plataforma para que desenvolvedores possam criar soluções e integrações utilizando informações relacionadas à gestão de pessoas, eventos, comunicação, pagamentos e financeiro.

A API utiliza endpoints REST e autenticação por API Key e API Secret. Também disponibiliza webhooks, registros de utilização e documentação interativa para apoiar o desenvolvimento das integrações.

A configuração e o desenvolvimento de uma integração exigem conhecimento técnico em APIs.

O que é possível fazer com a API da inChurch?

Atualmente, a documentação da API disponibiliza recursos relacionados aos seguintes módulos:

Pessoas

Permite realizar operações de criação, consulta, atualização e exclusão de informações relacionadas a:

membros;
visitantes;
líderes.

Essas operações são apresentadas na documentação como CRUD, termo técnico utilizado para representar as ações de criar, consultar, atualizar e excluir dados.

Notificações Push

Permite enviar notificações direcionadas para os aplicativos.

Grupos

Permite realizar a gestão de pequenos grupos por meio da integração.

Pagamentos

Disponibiliza recursos relacionados a:

processamento de doações;
acompanhamento de pagamentos;
relatórios relacionados aos pagamentos.

Eventos e inscrições

Na documentação técnica, esse conjunto de recursos aparece como Scheduling.

Por meio dele, é possível trabalhar com:

eventos;
inscrições;
pagamentos relacionados aos eventos.

Financeiro

A API disponibiliza recursos relacionados a:

lançamentos contábeis;
categorias;
centros de custo;
fornecedores.

Células

Permite gerenciar os vínculos de participantes às células.

Exemplos de utilização da API

De acordo com a documentação oficial, uma igreja pode utilizar a API para desenvolver diferentes tipos de solução, como:

sistemas próprios, incluindo totens ou portais para membros;
dashboards personalizados, utilizando métricas filtradas de membros;
automações, como integrações com bots de WhatsApp para notificações relacionadas a visitantes;
integrações contábeis, utilizando webhooks para comunicação com outros sistemas;
aplicativos próprios, incluindo o uso de notificações push.

Parceiros também podem utilizar a API para integração de produtos, sincronização de informações entre sistemas e criação de fluxos personalizados.

Como acessar a API Pública no painel

No painel de controle da inChurch:

No menu lateral, clique em Mais.
Selecione API.

Ao acessar o módulo, você encontrará as áreas de API, Webhooks e o acesso à Documentação.

Clientes da API

Para visualizar ou criar os acessos utilizados pelas integrações:

Acesse Mais > API.
Clique em Clientes da API.

Nessa tela, é possível visualizar os clientes cadastrados e informações como:

Nome do cliente;
API Key;
Abrangência.

Para iniciar a criação de um novo cliente, clique em + Novo, no canto superior direito.

Durante essa configuração, é possível definir as permissões sobre os recursos e operações que aquela integração poderá utilizar.

Logs de utilização

Dentro da área API, também está disponível a opção:

API > Logs de utilização

Essa área permite consultar os registros relacionados ao uso da API.

Os logs apoiam o acompanhamento e monitoramento das requisições realizadas pelas integrações. A disponibilização de registros e monitoramento faz parte dos recursos descritos na documentação oficial.

Webhooks

Os webhooks permitem que sistemas externos recebam notificações em tempo real quando determinados eventos ocorrerem na plataforma.

Na prática, isso permite criar integrações que reajam automaticamente a acontecimentos registrados na inChurch, sem depender apenas de consultas periódicas à API.

No painel, essa área está disponível em:

Mais > API > Webhooks > Webhooks

Logs de entrega dos Webhooks

Também é possível acessar:

Mais > API > Webhooks > Logs de entrega

Essa área reúne os registros relacionados às entregas realizadas pelos webhooks.

Documentação da API

Dentro do próprio módulo existe a opção Documentação.

Esse acesso direciona para a documentação técnica da API Pública da inChurch.

É nela que a pessoa responsável pelo desenvolvimento poderá consultar as informações necessárias para implementar uma integração, incluindo exemplos e referências técnicas dos recursos disponíveis.

A documentação oficial também possui uma referência interativa da API com exemplos.

Outros recursos disponíveis para integrações

Além dos módulos disponibilizados pela API, a documentação descreve alguns recursos que apoiam o desenvolvimento das integrações.

Filtros

A API oferece opções avançadas de filtragem para recuperação de dados.

Diferentes níveis de abrangência

O acesso pode ser limitado conforme a estrutura da organização:

Denominação;
Regional;
Igreja local.

Isso permite que uma integração trabalhe apenas dentro da abrangência definida para aquele cliente da API.

Paginação

As listagens da API utilizam um padrão de paginação para organizar a consulta dos registros.

Limite de requisições

Cada cliente da API pode realizar até 200 requisições por minuto.

Versionamento

A API utiliza versionamento semântico e prevê compatibilidade com versões anteriores.

Antes de começar uma integração

Antes de criar uma integração, defina:

qual sistema será conectado à inChurch;
quais informações serão utilizadas;
quais módulos da API serão necessários;
qual deverá ser a abrangência do acesso;
quem será responsável pelo desenvolvimento e manutenção da integração.

Como a API é um recurso técnico, recomendamos que a implementação seja conduzida por uma pessoa desenvolvedora ou equipe com conhecimento em integrações via API.

Resultado esperado

Com um cliente da API configurado, a equipe responsável pelo desenvolvimento poderá utilizar os recursos disponibilizados pela inChurch para criar integrações com sistemas externos.

As possibilidades da integração dependerão dos módulos, endpoints, permissões e abrangência disponíveis para aquele cliente.

Dúvidas frequentes

A API Pública está disponível no painel da inChurch?

Sim. O módulo API pode ser acessado pelo caminho Mais > API.

O que posso integrar usando a API?

A documentação disponibiliza recursos relacionados a Pessoas, Notificações Push, Grupos, Pagamentos, Eventos e inscrições, Financeiro e Células.

Posso utilizar a API para criar um sistema próprio?

Sim. A documentação cita como exemplos a criação de sistemas próprios, como totens e portais para membros.

É possível criar dashboards?

Sim. Entre os casos de uso documentados está a criação de dashboards personalizados utilizando métricas filtradas de membros.

A API pode ser integrada ao WhatsApp?

A documentação apresenta como exemplo de automação a integração com bots de WhatsApp para notificações relacionadas a visitantes. A implementação dependerá da solução externa utilizada para realizar essa integração.

O que são Webhooks?

São recursos que permitem enviar notificações em tempo real para sistemas externos quando determinados eventos acontecem.

Existe limite de uso da API?

Sim. A documentação estabelece o limite de 200 requisições por minuto para cada cliente da API.

Onde encontro as informações técnicas para desenvolver uma integração?

No próprio painel, acesse Mais > API > Documentação para abrir a documentação técnica da API Pública.