Ceci est une ancienne révision du document !


Flux de syndication

Le serveur Scrutari propose trois types de flux de syndication différents pour être tenu informé des nouvelles entrées dans le serveur. Ces trois flux sont au format Atom. Ils sont accessibles via une adresse décomposée comme suit :

/feed/{nom du flux}(-{options du flux})_{langue d'interface}.atom

Les options sont exprimées sous la forme d'une série de lettres accolées, à chaque lettre correspond une option (sur le même principe que les arguments d'une ligne de commande). La langue de l'interface est le code ISO classique de la langue qui doit être utilisé de préférence pour les intitulés.

Type de flux

Les trois flux diffèrent par le format et le nombre des entrées fournies par le flux. Ces flux sont les suivants :

  • tree : le flux comprend une entrée unique par mise à jour avec comme contenu les fiches et les mots-clés organisés suivant les bases, corpus et thésaurus d'origine ; ce flux est adapté pour un suivi interne de l'évolution du contenu d'un moteur Scrutari ; le flux contient l'entrée de la dernière mise à jour ainsi que les entrées de la dizaine de mises à jour précédentes
  • classes : équivalent au flux tree (une seule entrée par mise à jour) mais les fiches sont regroupées par classe de corpus ; ce flux n'a évidemment d'intérêt que si des classes de corpus sont définies dans le moteur Scrutari
  • fiches : le flux propose une entrée par fiche ajoutée dans le moteur ; seules les nouvelles fiches de la dernière mise à jour sont indiquées ; le contenu d'une entrée reprend les données d'une fiche (titre, sous-titre, champs complémentaires, attributs, mot-clé) et le lien de l'entrée pointe sur l'adresse de la fiche ; ce flux est le plus « lisible », c'est probablement celui qu'il faut privilégier à destination du public

Les options

Les options sont indiquées à l'aide d'une série de lettre à la suite du type de flux. Les options ne s'appliquent pas forcément à tous les types. Les options sont les suivantes :

  • f : n'indiquer que les fiches dans les nouveautés (les nouveaux mots-clés sont ignorés) (tree, classes)
  • s : ajouter le sous-titre (tree, classes)
  • c : ajouter les champs complémentaires (tree, classes)
  • m : ajouter les mots-clés (tree, classes)
  • i : ajouter l'icone de la fiche (tree, classes)
  • h : le texte XML est indenté, utile à des fins de débogage (tous les flux)
  • v : demande que le titre de chaque entrée soit sous la forme d'une série de variables, à utiliser s'il fait l'objet d'un post-traitement (tree, classes)

Exemples

Pour la Coredem :

Filtrer les fiches par une recherche

Le flux fiches a ceci de particulier qu'il accepte les mêmes paramètres de recherche que la requête JSON q-fiche. Lorsqu'une recherche est ainsi définie, un filtre est appliqué aux entrées du flux de syndication : seules les fiches répondant au critère de recherche sont insérées dans le flux (ce qui peut conduire à un flux vide).

Exemple

Filtrer les fiches par l'identifiant d'une recherche

Le filtre le plus intéressant est celui qui consiste à filtrer à partir de l'identifiant d'une recherche réalisée précédemment. Ce filtre a deux intérêts majeurs par rapport au filtre précédent :

  • le résultat de la recherche est mis en cache, or les flux de syndication sont consultés très régulièrement, cela réduit donc le temps de traitement
  • Dans les deux jours qui suivent la recherche, le flux renvoie toutes les fiches de la recherche ; cela permet de proposer à l'internaute qui vient d'effectuer une recherche un lien de syndication qui, d'une part, lui permettra de retrouver les fiches de sa recherche dans son agrégateur et qui, d'autre part, transmettra à chaque mise à jour les nouvelles fiches répondant au critère de recherche. Au delà des deux jours, il est possible de forcer le téléchargement de toutes les fiches (et pas seulement des nouveautés) en rajoutant le paramètre all=1 à l'Url du flux.
serveurscrutari/syndication.1385998571.txt.gz · Dernière modification: 2013/12/02 16:36 par vincent
CC Attribution-Share Alike 4.0 International
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0