Paramètres de recherche disponibles

Dernière mise à jour: il y a 3 mois

L’endpoint /resources accepte plusieurs paramètres pour affiner vos résultats de recherche.

Recherche de base

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

Paramètres

query (string, optionnel)

Votre terme de recherche. Laissez vide pour obtenir toutes les ressources.

  • Exemples : "Virgin Mary", "Eucharist", "cross"

  • Prend en charge la correspondance approximative et la tolérance aux fautes de frappe

  • Recherche dans les titres, les descriptions et les tags

page (entier, par défaut : 1)

La page de résultats à renvoyer. Commence à 1.

page_size (entier, par défaut : 20, max : 100)

Nombre de résultats par page. Le maximum est 100 pour maintenir les performances.

order (string, par défaut : "popular")

Comment trier les résultats :

  • popular - Les ressources les plus téléchargées d’abord

  • recent - Les téléversements les plus récents d’abord

Structure de la réponse

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

Exemples pratiques

Obtenir les 10 ressources les plus populaires sur la prière :

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

Obtenir les téléversements récents, sans terme de recherche spécifique :

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

Parcourir la page 3 d’images de saints :

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

Pour consulter la référence complète de l’API, visitez api.cathopic.com/docs.

Cet article vous a-t-il été utile ?