Parametri di ricerca disponibili

Ultimo aggiornamento: 3 mesi fa

L’endpoint /resources accetta diversi parametri per affinare i risultati della tua ricerca.

Ricerca di base

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

Parametri

query (string, opzionale)

Il termine di ricerca. Lascia vuoto per ottenere tutte le risorse.

  • Esempi: "Vergine Maria", "Eucaristia", "croce"

  • Supporta il matching fuzzy e la tolleranza per gli errori di battitura

  • Cerca tra titoli, descrizioni e tag

page (integer, predefinito: 1)

Quale pagina dei risultati restituire. Inizia da 1.

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

Numero di risultati per pagina. Il massimo è 100 per mantenere le prestazioni.

order (string, predefinito: "popular")

Come ordinare i risultati:

  • popular - Prima le risorse più scaricate

  • recent - Prima i caricamenti più recenti

Struttura della risposta

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

Esempi pratici

Ottieni le prime 10 risorse più popolari sulla preghiera:

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

Ottieni i caricamenti recenti, senza un termine di ricerca specifico:

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

Sfoglia la pagina 3 di immagini sui santi:

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

Per un riferimento completo dell’API, visita api.cathopic.com/docs.

Questo articolo è stato utile?