API publiczne intencji mszalnych
Publiczne API Parafio umożliwia pobieranie harmonogramu mszy wraz z intencjami mszalnymi. Możesz wykorzystać je do zbudowania własnego kalendarza intencji na stronie internetowej parafii lub w innym oprogramowaniu.
Adres bazowy API: https://donate.deum.eu
Jak uzyskać dostęp do API
Aby API zwracało dane intencji, musisz najpierw włączyć publiczny dostęp w panelu administracyjnym Parafio:
- Zaloguj się do panelu administracyjnego Parafio (admin.parafio.com)
- W głównym menu kliknij Ustawienia
- Wybierz Intencje terminowe
- W sekcji Integracja ze stroną internetową zaznacz opcję „Treści intencji dostępne publicznie poprzez API”
- Kliknij „Zaktualizuj ustawienia” na dole strony
Ważne:
- Bez zaznaczonej opcji API nie zwróci treści intencji
- Jeśli nie chcesz, aby treści intencji były dostępne publicznie, nie zaznaczaj tej opcji
Więcej informacji o tej opcji znajdziesz w dokumentacji Ustawienia Intencji Terminowych Online.
Identyfikator konta (accountId)
Każde zapytanie do API wymaga identyfikatora konta parafii (accountId) w ścieżce URL.
Aby uzyskać accountId, skontaktuj się z supportem Parafio: [email protected].
Endpoint zalecany (v2)
Zalecany endpoint zwraca listę mszy z intencjami oraz kalendarz liturgiczny.
Metoda: GET
URL:
https://donate.deum.eu/api/v2/accounts/{accountId}/masses/public?from=2019-01-01&to=2019-01-31
Parametry
| Parametr | Lokalizacja | Wymagany | Opis |
|---|---|---|---|
accountId | ścieżka | tak | Identyfikator konta parafii |
from | zapytanie | tak | Data początkowa zakresu (format YYYY-MM-DD, np. 2019-01-01) |
to | zapytanie | tak | Data końcowa zakresu (format YYYY-MM-DD, np. 2019-01-31) |
PARAFIO-Language | nagłówek | nie | Preferowany język użytkownika (np. pl-PL) |
Accept-Language | nagłówek | nie | Używany, gdy nagłówek PARAFIO-Language jest nieobecny (np. pl-PL,en;q=0.9) |
Ograniczenia
- W jednym zapytaniu można pobrać dane za maksymalnie 60 dni
- API jest publiczne — nie wymaga nagłówków autoryzacyjnych, ale dostęp do danych musi być włączony w panelu parafii
Przykład żądania
curl -H "PARAFIO-Language: pl-PL" \
"https://donate.deum.eu/api/v2/accounts/123456789/masses/public?from=2019-01-01&to=2019-01-31"
Endpoint przestarzały (deprecated)
Uwaga: Poniższy endpoint zostanie w przyszłości wycofany. Zalecamy migrację na wersję v2 (/api/v2/...), która dodatkowo zwraca kalendarz liturgiczny.
Metoda: GET
URL:
https://donate.deum.eu/accounts/{accountId}/masses/public?from=2019-01-01&to=2019-01-31
Parametry zapytania (accountId, from, to) i ograniczenie 60 dni są takie same jak w wersji v2. Endpoint v1 nie przyjmuje nagłówków języka. Format pojedynczej mszy jest taki sam jak w v2. Różnica polega na tym, że odpowiedź v1 zwraca wyłącznie tablicę mszy (bez pola liturgical_calendar).
Przykład żądania
curl "https://donate.deum.eu/accounts/123456789/masses/public?from=2019-01-01&to=2019-01-31"
Struktura odpowiedzi
Odpowiedź v2
Odpowiedź wersji v2 to obiekt JSON z dwoma polami:
| Pole | Typ | Opis |
|---|---|---|
liturgical_calendar | tablica | Wpisy kalendarza liturgicznego dla zakresu dat |
masses | tablica | Lista mszy z intencjami |
Wpis kalendarza liturgicznego
Każdy element tablicy liturgical_calendar zawiera:
| Pole | Typ | Opis |
|---|---|---|
date | string | Data w formacie YYYY-MM-DD (np. 2016-11-04) |
name | string | Nazwa dnia liturgicznego (np. Uroczystość Narodzenia Pańskiego) |
holiday_type | string | Typ dnia liturgicznego (patrz tabela poniżej) |
Wartości pola holiday_type:
| Wartość API | Znaczenie |
|---|---|
solemnity_primary_holiday | Uroczystość |
feast_secondary_holiday | Święto |
obligatory_memorial | Święto obowiązkowe |
optional_memorial | Wspomnienie dowolne |
other | Inny dzień |
Msza
Każdy element tablicy masses zawiera:
| Pole | Typ | Opis |
|---|---|---|
mass_date | string | Data i godzina mszy (np. 2016-11-04T00:00:00+0000) |
public_note | string / null | Publiczna notatka (np. miejsce odprawy mszy) |
available_mass_offerings | integer | Liczba wolnych miejsc na intencje |
offerings | tablica | Lista przyjętych intencji |
has_hour | boolean | Czy msza ma określoną godzinę |
is_collective | boolean | Czy msza jest zbiorowa |
has_unlimited_offerings | boolean | Czy msza nie ma limitu intencji |
unavailable_because_of_minimum_from_date | boolean | Czy msza jest niedostępna do zamówienia intencji online z powodu ustawienia minimalnej daty |
unavailable_because_of_maximum_to_date | boolean | Czy msza jest niedostępna do zamówienia intencji online z powodu ustawienia maksymalnej daty |
unavailable_because_of_even_distribution | boolean | Czy msza jest niedostępna z powodu reguł równomiernego rozłożenia intencji |
available_for_intention_requests | boolean | Czy na tę mszę można zamówić intencję |
intention_request_url | string / null | Publiczny URL formularza zamówienia intencji na tę mszę |
Intencja
Każdy element tablicy offerings zawiera:
| Pole | Typ | Opis |
|---|---|---|
offering_content | string | Treść intencji |
is_public | boolean | Czy intencja jest publiczna |
book_of_intention | string | Rodzaj księgi intencji (np. standard) |
Przykładowa odpowiedź v2
{
"liturgical_calendar": [
{
"date": "2016-11-04",
"name": "Uroczystość Narodzenia Pańskiego",
"holiday_type": "feast_secondary_holiday"
}
],
"masses": [
{
"mass_date": "2016-11-04T00:00:00+0000",
"public_note": "Msza odprawiana w kaplicy bocznej",
"available_mass_offerings": 1,
"has_hour": true,
"is_collective": false,
"has_unlimited_offerings": false,
"unavailable_because_of_minimum_from_date": false,
"unavailable_because_of_maximum_to_date": false,
"unavailable_because_of_even_distribution": false,
"available_for_intention_requests": true,
"intention_request_url": "https://parafio.com/demo-deum/intencje?date=2016-11-04",
"offerings": [
{
"offering_content": "[Nazwisko Parafianina]",
"is_public": true,
"book_of_intention": "standard"
}
]
}
]
}
Więcej informacji
- Dla developerów — strona główna sekcji
- Ustawienia Intencji Terminowych Online — włączenie dostępu do API w panelu
- Kalendarz intencji – wtyczka WordPress — alternatywa bez własnej integracji API