API d'accès externe aux ressources

Actions

Sont listées ci-dessous toutes les actions disponibles par cette API

/search

Recherche une liste de ressources en mode plein-texte norme Lucène
Syntaxe

/api/search ? query={QUERY} & limit={LIMIT} & offset={OFFSET} & mime={MIME}


Paramètres
  • [obligatoire] {QUERY} Chaîne de recherche plein-texte
  • [optionnel] {LIMIT} Nombre maximal de ressources renvoyées (par défaut : 50)
  • [optionnel] {OFFSET} Offset de la première ressource renvoyée (par défaut : 0)
  • [optionnel] {MIME} Format de retour (xml | json | csv)

Exemple

https://fresques.ina.fr/jalons/api/search?query=nature&limit=5&offset=5

/resources

Retourne toutes les ressources
Syntaxe

/api/resources ? sort={SORT} & direction={DIRECTION} & limit={LIMIT} & offset={OFFSET} & mime={MIME}


Paramètres
  • [optionnel] {SORT} Propriété sur laquelle trier les ressources
  • [optionnel] {DIRECTION} Direction de tri (asc|desc)
  • [optionnel] {LIMIT} Nombre maximal de ressources renvoyées (par défaut : 50)
  • [optionnel] {OFFSET} Offset de la première ressource renvoyée (par défaut : 0)
  • [optionnel] {MIME} Format de retour (xml | json | csv)

Exemple

https://fresques.ina.fr/jalons/api/resources?sort=title

/resource

Cible une ressource
Syntaxe

/api/resource/{ID} ? mime={MIME}


  • [obligatoire] {ID} Identifiant de ressource
  • [optionnel] {MIME} Format de retour (xml | json | csv)

Exemple

https://fresques.ina.fr/jalons/api/resource/InaEdu00001

Ressources

Une ressource représente un document du projet. Elle dispose de propriétés explicitées dans ce chapitre.

Propriétés des ressources

Cette section décrit propriétés communes à toutes les ressources quelque soit leurs types
  • [string] id Identifiant de ressource
  • [string] title Titre de la ressource
  • [date] date Date de diffusion de la ressource
  • [string] description Description et résumé du contenu de la ressource
  • [url] url Lien vers la ressource
  • [url] thumbnail Imagette représentative de la ressource
  • [number] thumbnail_width Largeur de l’imagette en pixels
  • [number] thumbnail_height Hauteur de l’imagette en pixels
  • [string] type Type de ressource (video | photo | entretien)
  • [string] locale Langue de la ressource (fra | eng | bre | ...)

Métadonnées

Dans le cadre d'une alimentation de moteur de recherche partenaire, il est possible d'intégrer dans la réponse les métadonnées des ressources.
  • [list] people Liste des personnalités attachées à la ressource
  • [tree] themes Arbre des thèmes attachés à la ressource
  • [tree] geolocations Arbre des localisations attachées à la ressource

Pour activer les métadonnées dans n'importe quelle action, il suffit d'ajouter le paramètre « metas » dans l'URL.
Exemple

https://fresques.ina.fr/jalons/api/resource/InaEdu00001?metas=1

Types de ressources

Une ressource peut être de type vidéo, photo ou entretien. Aux propriétés communes listées dans la paragraphe précédent, se rajoutent des propriétés spécifiques à chaque type.

Type video

  • [number] duration Durée de la vidéo
  • [string] html Code embed du lecteur vidéo exportable
  • [number] width Largeur du lecteur vidéo exportable
  • [number] height Hauteur du lecteur vidéo exportable

Type photo

  • [url] photo_url Lien vers l’image originale en plein format
  • [string] html Code embed de la visionneuse de photo exportable
  • [number] width Largeur de la visionneuse de photo exportable
  • [number] height Largeur de la visionneuse de photo exportable

Type entretien

À venir...