Przejdź do głównej zawartości

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:

  1. Zaloguj się do panelu administracyjnego Parafio (admin.parafio.com)
  2. W głównym menu kliknij Ustawienia
  3. Wybierz Intencje terminowe
  4. W sekcji Integracja ze stroną internetową zaznacz opcję „Treści intencji dostępne publicznie poprzez API”
  5. 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

ParametrLokalizacjaWymaganyOpis
accountIdścieżkatakIdentyfikator konta parafii
fromzapytanietakData początkowa zakresu (format YYYY-MM-DD, np. 2019-01-01)
tozapytanietakData końcowa zakresu (format YYYY-MM-DD, np. 2019-01-31)

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 "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, ograniczenia i format odpowiedzi dla listy mszy są takie same jak w wersji 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:

PoleTypOpis
liturgical_calendartablicaWpisy kalendarza liturgicznego dla zakresu dat
massestablicaLista mszy z intencjami

Wpis kalendarza liturgicznego

Każdy element tablicy liturgical_calendar zawiera:

PoleTypOpis
datestringData w formacie YYYY-MM-DD (np. 2016-11-04)
holiday_typestringTyp dnia liturgicznego (patrz tabela poniżej)

Wartości pola holiday_type:

Wartość APIZnaczenie
solemnity_primary_holidayUroczystość
feast_secondary_holidayŚwięto
obligatory_memorialŚwięto obowiązkowe
optional_memorialWspomnienie dowolne
otherInny dzień

Msza

Każdy element tablicy masses zawiera:

PoleTypOpis
mass_datestringData i godzina mszy (np. 2016-11-04T00:00:00+0000)
public_notestring / nullPubliczna notatka (np. miejsce odprawy mszy)
available_mass_offeringsintegerLiczba wolnych miejsc na intencje
offeringstablicaLista przyjętych intencji
has_hourbooleanCzy msza ma określoną godzinę
is_collectivebooleanCzy msza jest zbiorowa

Intencja

Każdy element tablicy offerings zawiera:

PoleTypOpis
offering_contentstringTreść intencji
is_publicbooleanCzy intencja jest publiczna
book_of_intentionstringRodzaj księgi intencji (np. standard)

Przykładowa odpowiedź v2

{
"liturgical_calendar": [
{
"date": "2016-11-04",
"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,
"offerings": [
{
"offering_content": "[Nazwisko Parafianina]",
"is_public": true,
"book_of_intention": "standard"
}
]
}
]
}

Więcej informacji