Apidae Photo

Apidae Photo est un module indépendant qui permet d’évaluer la qualité des visuels présents dans Apidae. Chaque visuel peut être tagué (portait, activité, hôtel…) et noté entre 1 et 5.

Est détaillée ici l’utilisation de l’API de lecture liée à Apidae Photo. L’utilisation de cette API nécessite un nouvel appel API pour chaque fiche.
=> Il est possible d’obtenir l’ensemble de ces informations en un seul appel en utilisant les API enrichies.

Apidae Photo alimente la métadonnée apidae-photo. La présence de cette métadonnée, même vide, sur une fiche objet permet de savoir si des données Apidae Photo sont disponibles pour des visuels de cet objet.
À noter que la métadonnée contient la note moyenne de l’image principale de l’offre, basée sur l’ensemble des notes fournies par les membres.

"metadonnees" : [ {
    "noeudId" : "apidae-photo",
    "contenus" : [ {
      "cible" : "general",
      "metadonnee" : {
        "noteImagePrincipale": 4.0
      }
    } ]
  },
  ...
]

L’API permet d’obtenir, au choix, une liste de résultats ou le détail pour une photo donnée.
Chaque photo peut être notée par un ou plusieurs membres d’Apidae.

L’API contient pour chaque photo deux types de données :

• La note précise du membre et les éventuels tags.
• La note moyenne donnée par l’ensemble des membres.

{
    "apidaePhotoId": 210795,
    "illustrationId": 13573971,
    "note": 4.5,
    "noteMembre": {
        "note": 5,
        "tags": [
            "Eté",
            "Randonneur",
            "Paysage",
            "Lac montagne"
        ]
    },
    "notesReseau": [
        {
            "note": 4,
            "tags": []
        }
    ]
}

Environnements correspondants
base.apidae-tourisme.com : https://photo.apidae-tourisme.com/api/
base.apidae-tourisme.cooking : https://preprod-apidae-photo.apidae.net/api/

Obtention d’une liste de notes

https://photo.apidae-tourisme.com/api/images.json?membreId={1234}&selectionIds=[{88358}]&projetId={4567}&objetId={12345}&illustrationId={1357}&first={20}&count={50}

Description des paramètres de requête

Le paramètre membreId est obligatoire. Il est préconisé de fournir au moins un identifiant de sélection ou de projet Apidae pour limiter le nombre de résultats.

Exemple de résultat

[
    {
        "apidaePhotoId": 210592,
        "illustrationId": 13567143,
        "note": 3.0,
        "noteMembre": {
            "note": 3,
            "tags": [
                "Eté",
                "Faune sauvage"
            ]
        }
    },
    {
        "apidaePhotoId": 210591,
        "illustrationId": 13567481,
        "note": 3.0,
        "noteMembre": {
            "note": 3,
            "tags": [
                "Eté",
                "Architecture locale"
            ]
        }
    }
]

Obtention des notes d’une seule image

Cette requête retourne la note du membre courant ainsi que les notes de tous les autres membres s’il y en a.

https://photo.apidae-tourisme.com/api/images/{apidaePhotoId}.json?membreId={1234}

Exemple de résultat

{
    "apidaePhotoId": 210574,
    "illustrationId": 13567084,
    "note": 3.0,
    "noteMembre": {
        "note": 2,
        "tags": [
            "Printemps"
        ]
    },
    "notesReseau": [
        {
            "note": 4,
            "tags": []
        }
    ]
}