Verfügbare Suchparameter - Hilfecenter

Der Endpunkt /resources akzeptiert mehrere Parameter, um Ihre Suchergebnisse zu verfeinern.

Grundlegende Suche

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

Parameter

query (string, optional)

Ihr Suchbegriff. Lassen Sie ihn leer, um alle Ressourcen zu erhalten.

Beispiele: "Virgin Mary", "Eucharist", "cross"
Unterstützt unscharfes Matching und Tippfehler-Toleranz
Durchsucht Titel, Beschreibungen und Tags

page (integer, default: 1)

Welche Seite der Ergebnisse zurückgegeben werden soll. Beginnt bei 1.

page_size (integer, default: 20, max: 100)

Anzahl der Ergebnisse pro Seite. Das Maximum ist 100, um die Performance zu erhalten.

order (string, default: "popular")

So werden die Ergebnisse sortiert:

popular - Zuerst die meist heruntergeladenen Ressourcen
recent - Zuerst die neuesten Uploads

Antwortstruktur

{
  "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"]
    }
  ]
}

Praktische Beispiele

Die ersten 10 meistbeliebten Ressourcen zum Thema Gebet abrufen:

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

Neueste Uploads abrufen, ohne bestimmten Suchbegriff:

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

Seite 3 mit Heiligenbildern durchsuchen:

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

Für die vollständige API-Referenz besuchen Sie api.cathopic.com/docs.