Começar com a API pública
Crie a sua conta de programador, gere a sua chave sk_live_ e faça a sua primeira chamada à API Sanctumel em cinco minutos.
A API pública Sanctumel permite apresentar os dados públicos de uma igreja em qualquer site ou aplicação: perfil, próximos eventos, anúncios e estado do direto. Dá também acesso à Bíblia em várias línguas. É apenas de leitura, gratuita, e utiliza-se com uma chave API pessoal.
1. Criar a sua conta de programador
- Abra developers.sanctumel.com e clique em Obter a minha chave API.
- Escolha o separador Criar uma conta e preencha o seu nome, email e palavra-passe.
- Abra o email de verificação recebido e confirme o seu endereço. Este passo é obrigatório: é impossível criar uma chave com um endereço não verificado.
Nota: a conta de programador é independente de uma conta de igreja. Pode ser programador sem administrar nenhuma igreja.
2. Gerar a sua chave
- Inicie sessão na página As minhas chaves API.
- Dê um nome à sua chave (por exemplo « Site da paróquia ») e clique em Criar uma chave.
- Copie a chave imediatamente. Começa por
sk_live_e nunca mais será apresentada: a Sanctumel guarda apenas uma impressão criptográfica, tal como para uma palavra-passe.
Pode ter até 5 chaves ativas ao mesmo tempo (uma por site ou aplicação, é a boa prática) e revogar cada uma a qualquer momento - a revogação é imediata.
3. Primeira chamada
Todos os pedidos são feitos em HTTPS com a sua chave no cabeçalho Authorization:
curl https://api.sanctumel.com/api/public/v1/churches/mon-eglise \
-H "Authorization: Bearer sk_live_votre_cle"
A resposta é JSON:
{
"slug": "mon-eglise",
"name": "Mon Église",
"city": "Bruxelles",
"country": "BE",
"language": "fr",
"publicPage": "https://sanctumel.com/p/…"
}
Que igrejas estão acessíveis?
Apenas as que tornaram o seu perfil público. Cada igreja decide a sua visibilidade nas suas definições Sanctumel; uma igreja não pública devolve 404 - a API nem sequer revela a sua existência. O slug de uma igreja pública é visível no endereço da sua página Sanctumel.
Limites e erros
| Código | Significado | O que fazer |
|---|---|---|
401 | Chave ausente, inválida ou revogada | Verifique o cabeçalho Authorization: Bearer sk_live_… |
404 | Igreja não encontrada ou perfil não público | Verifique o slug; a igreja deve ter escolhido a visibilidade pública |
405 | Método não permitido | A API é apenas de leitura: unicamente GET |
429 | Demasiados pedidos | Limite: 120 pedidos/minuto por chave - use cache do seu lado |
Boas práticas de segurança
- Nunca coloque a chave em código visível pelo navegador (JavaScript front): chame a API a partir do seu servidor e sirva o resultado às suas páginas.
- Uma chave por utilização: se um site for comprometido, revogue a sua chave sem tocar nas outras.
- Guarde as respostas em cache (os eventos não mudam a cada segundo): ficará longe do limite de pedidos.
Ir mais longe
- Referência dos endpoints - todos os endpoints, parâmetros e respostas detalhadas.