Dostępne parametry wyszukiwania

Punkt końcowy /resources obsługuje kilka parametrów, które pozwalają doprecyzować wyniki wyszukiwania.

Podstawowe wyszukiwanie

POST https://api.cathopic.com/resources
{
  "query": "Saint Francis",
  "page": 1,
  "page_size": 20,
  "order": "popular"
}

Parametry

query (string, opcjonalnie)

Twoje hasło wyszukiwania. Zostaw puste, aby otrzymać wszystkie zasoby.

• Przykłady: "Virgin Mary", "Eucharist", "cross"

• Obsługuje dopasowanie przybliżone i tolerancję literówek

• Wyszukuje w tytułach, opisach i tagach

page (integer, domyślnie: 1)

Którą stronę wyników zwrócić. Zaczyna się od 1.

page_size (integer, domyślnie: 20, max: 100)

Liczba wyników na stronę. Maksimum to 100, aby utrzymać wydajność.

order (string, domyślnie: "popular")

Jak sortować wyniki:

• popular - Najpierw najczęściej pobierane zasoby

• recent - Najpierw najnowsze dodane materiały

Struktura odpowiedzi

{
  "total": 1523,
  "page": 1,
  "page_size": 20,
  "results": [
    {
      "id": 1234,
      "name": "Resource title",
      "description": "Resource description",
      "type": "photo",
      "orientation": "portrait",
      "thumbnail_url": "https://...",
      "author": { ... },
      "tags": ["tag1", "tag2"]
    }
  ]
}

Przykłady praktyczne

Pobierz pierwsze 10 najpopularniejszych zasobów dotyczących modlitwy:

{
  "query": "prayer",
  "page": 1,
  "page_size": 10,
  "order": "popular"
}

Pobierz najnowsze dodania, bez konkretnego hasła wyszukiwania:

{
  "query": "",
  "page": 1,
  "page_size": 50,
  "order": "recent"
}

Przeglądaj stronę 3 obrazów o świętych:

{
  "query": "saints",
  "page": 3,
  "page_size": 20,
  "order": "popular"
}

Aby zapoznać się z pełną dokumentacją API, odwiedź api.cathopic.com/docs.