Aan de slag met de publieke API
Maak uw ontwikkelaarsaccount aan, genereer uw sk_live_ sleutel en doe uw eerste aanroep naar de Sanctumel API in vijf minuten.
Met de publieke API van Sanctumel kunt u de publieke gegevens van een kerk tonen op elke website of applicatie: profiel, aankomende evenementen, aankondigingen en livestatus. Ze geeft ook toegang tot de Bijbel in meerdere talen. De API is alleen-lezen, gratis, en wordt gebruikt met een persoonlijke API-sleutel.
1. Uw ontwikkelaarsaccount aanmaken
- Open developers.sanctumel.com en klik op Mijn API-sleutel verkrijgen.
- Kies het tabblad Account aanmaken en vul uw naam, e-mailadres en wachtwoord in.
- Open de ontvangen verificatie-e-mail en bevestig uw adres. Deze stap is verplicht: het is onmogelijk een sleutel aan te maken met een niet-geverifieerd adres.
Opmerking: het ontwikkelaarsaccount staat los van een kerkaccount. U kunt ontwikkelaar zijn zonder een kerk te beheren.
2. Uw sleutel genereren
- Meld u aan op de pagina Mijn API-sleutels.
- Geef uw sleutel een naam (bijvoorbeeld "Parochiewebsite") en klik op Sleutel aanmaken.
- Kopieer de sleutel onmiddellijk. Hij begint met
sk_live_en wordt nooit meer getoond: Sanctumel bewaart er alleen een cryptografische vingerafdruk van, net als bij een wachtwoord.
U kunt tot 5 actieve sleutels tegelijk hebben (één per website of applicatie, dat is de beste praktijk) en elke sleutel op elk moment intrekken - de intrekking is onmiddellijk.
3. Eerste aanroep
Alle verzoeken verlopen via HTTPS met uw sleutel in de Authorization-header:
curl https://api.sanctumel.com/api/public/v1/churches/mon-eglise \
-H "Authorization: Bearer sk_live_votre_cle"
Het antwoord is JSON:
{
"slug": "mon-eglise",
"name": "Mon Église",
"city": "Bruxelles",
"country": "BE",
"language": "fr",
"publicPage": "https://sanctumel.com/p/…"
}
Welke kerken zijn toegankelijk?
Alleen kerken die hun profiel publiek hebben gemaakt. Elke kerk bepaalt haar zichtbaarheid in haar Sanctumel-instellingen; een niet-publieke kerk geeft 404 terug - de API onthult zelfs haar bestaan niet. De slug van een publieke kerk is zichtbaar in het adres van haar Sanctumel-pagina.
Limieten en fouten
| Code | Betekenis | Wat te doen |
|---|---|---|
401 | Sleutel ontbreekt, ongeldig of ingetrokken | Controleer de header Authorization: Bearer sk_live_… |
404 | Kerk niet gevonden of profiel niet publiek | Controleer de slug; de kerk moet publieke zichtbaarheid hebben gekozen |
405 | Methode niet toegestaan | De API is alleen-lezen: alleen GET |
429 | Te veel verzoeken | Limiet: 120 verzoeken/minuut per sleutel - gebruik caching aan uw kant |
Beveiligingsbest practices
- Zet de sleutel nooit in code die zichtbaar is voor de browser (front-end JavaScript): roep de API aan vanaf uw server en lever het resultaat aan uw pagina's.
- Eén sleutel per gebruik: als een site gecompromitteerd raakt, trekt u de sleutel ervan in zonder de andere aan te raken.
- Zet de antwoorden in cache (evenementen veranderen niet elke seconde): zo blijft u ver onder de snelheidslimiet.
Verder gaan
- Endpointreferentie - alle endpoints, parameters en gedetailleerde antwoorden.