Elérhető keresési paraméterek - Súgóközpont

A /resources végpont több paramétert is elfogad, amelyekkel pontosíthatja a keresési találatokat.

Alap keresés

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

Paraméterek

query (string, opcionális)

A keresési kifejezés. Hagyja üresen az összes erőforrás megjelenítéséhez.

Példák: "Szűz Mária", "Eucharisztia", "kereszt"
Fuzzy egyezést és gépelési hibák tűrését is támogatja
A címekben, leírásokban és címkékben keres

page (egész szám, alapértelmezett: 1)

Az eredmények melyik oldalát adja vissza. 1-től indul.

page_size (egész szám, alapértelmezett: 20, max: 100)

Eredmények száma oldalonként. A maximális érték 100, a teljesítmény fenntartása érdekében.

order (string, alapértelmezett: "popular")

Az eredmények rendezése:

popular - Először a legtöbbször letöltött erőforrások
recent - Először a legújabb feltöltések

Válaszstruktúra

{
  "total": 1523,
  "page": 1,
  "page_size": 20,
  "results": [
    {
      "id": 1234,
      "name": "Erőforrás címe",
      "description": "Erőforrás leírása",
      "type": "photo",
      "orientation": "portrait",
      "thumbnail_url": "https://...",
      "author": { ... },
      "tags": ["tag1", "tag2"]
    }
  ]
}

Gyakorlati példák

Az első 10 legnépszerűbb imádsággal kapcsolatos erőforrás lekérése:

{
  "query": "imádság",
  "page": 1,
  "page_size": 10,
  "order": "popular"
}

Legutóbbi feltöltések lekérése, nincs konkrét keresési kifejezés:

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

3. oldal megtekintése a szentekről szóló képekből:

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

A teljes API-hivatkozásért látogasson el ide: api.cathopic.com/docs.