Beschikbare zoekparameters

Laatst bijgewerkt: 3 maanden geleden

De /resources endpoint accepteert verschillende parameters om je zoekresultaten te verfijnen.

Basiszoekopdracht

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

Parameters

query (string, optioneel)

Je zoekterm. Laat leeg om alle resources op te halen.

  • Voorbeelden: "Maagd Maria", "Eucharistie", "kruis"

  • Ondersteunt fuzzy matching en tolerantie voor typefouten

  • Zoekt in titels, beschrijvingen en tags

page (integer, standaard: 1)

Welke pagina met resultaten moet worden teruggegeven. Begint bij 1.

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

Aantal resultaten per pagina. Maximum is 100 om de prestaties te behouden.

order (string, standaard: "popular")

Zo sorteer je resultaten:

  • popular - Eerst de meest gedownloade resources

  • recent - Eerst de nieuwste uploads

Structuur van de respons

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

Praktische voorbeelden

Haal de eerste 10 meest populaire resources op over gebed:

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

Haal recente uploads op, zonder specifieke zoekterm:

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

Blader door pagina 3 met afbeeldingen van heiligen:

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

Voor de volledige API-referentie, ga naar api.cathopic.com/docs.

Was dit artikel nuttig?